-
Notifications
You must be signed in to change notification settings - Fork 2
/
exception.html
776 lines (696 loc) · 107 KB
/
exception.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>SDK Exceptions — C++ SDK 2.6.0 documentation</title>
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/graphviz.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/custom.css" type="text/css" />
<link rel="shortcut icon" href="../../../_static/favicon.ico"/>
<!--[if lt IE 9]>
<script src="../../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
<script src="../../../_static/jquery.js"></script>
<script src="../../../_static/underscore.js"></script>
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="../../../_static/doctools.js"></script>
<script src="../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
<link rel="next" title="Event Handling Interface" href="event_handling.html" />
<link rel="prev" title="Logging" href="log_level.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../../index.html" class="icon icon-home">
C++ SDK
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../../../index.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../other/getting_started.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../other/run_time_deps.html">Run Time Dependencies</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../other/supported_platforms.html">Supported Platforms</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../../coresdk.html">Core API</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../sdk.html">Sdk Interface</a></li>
<li class="toctree-l2"><a class="reference internal" href="../session.html">Session Service</a></li>
<li class="toctree-l2"><a class="reference internal" href="../conference.html">Conference Service</a></li>
<li class="toctree-l2"><a class="reference internal" href="../audio.html">Audio Service</a></li>
<li class="toctree-l2"><a class="reference internal" href="../video.html">Video Service</a></li>
<li class="toctree-l2"><a class="reference internal" href="../device_management.html">Device Management Service</a></li>
<li class="toctree-l2"><a class="reference internal" href="async_ops.html">Asynchronous Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="log_level.html">Logging</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">SDK Exceptions</a></li>
<li class="toctree-l2"><a class="reference internal" href="event_handling.html">Event Handling Interface</a></li>
<li class="toctree-l2"><a class="reference internal" href="custom_allocator.html">Overriding new/delete operators</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../media_io.html">Media IO API</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../plugins.html">Plugins</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../index.html">C++ SDK</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="../../coresdk.html">Core API</a></li>
<li class="breadcrumb-item active">SDK Exceptions</li>
<li class="wy-breadcrumbs-aside">
<a href="../../../_sources/api/sdk/common/exception.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="sdk-exceptions">
<span id="api-exception"></span><h1>SDK Exceptions<a class="headerlink" href="#sdk-exceptions" title="Permalink to this heading"></a></h1>
<p>#include <dolbyio/comms/exception.h></p>
<p>Exception’s which can be thrown by the SDK and caught by user. These have been left defined</p>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms9exceptionE">
<span id="_CPPv3N7dolbyio5comms9exceptionE"></span><span id="_CPPv2N7dolbyio5comms9exceptionE"></span><span id="dolbyio::comms::exception"></span><span class="target" id="classdolbyio_1_1comms_1_1exception"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">exception</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N7dolbyio5comms9exceptionE" title="dolbyio::comms::exception"><span class="n"><span class="pre">exception</span></span></a><a class="headerlink" href="#_CPPv4N7dolbyio5comms9exceptionE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The base class for the SDK exceptions. </p>
<p>Subclassed by <a class="reference internal" href="#classdolbyio_1_1comms_1_1async__operation__canceled"><span class="std std-ref">dolbyio::comms::async_operation_canceled</span></a>, <a class="reference internal" href="#classdolbyio_1_1comms_1_1certificate__exception"><span class="std std-ref">dolbyio::comms::certificate_exception</span></a>, <a class="reference internal" href="#classdolbyio_1_1comms_1_1conference__exception"><span class="std std-ref">dolbyio::comms::conference_exception</span></a>, <a class="reference internal" href="#classdolbyio_1_1comms_1_1io__exception"><span class="std std-ref">dolbyio::comms::io_exception</span></a>, <a class="reference internal" href="#classdolbyio_1_1comms_1_1json__exception"><span class="std std-ref">dolbyio::comms::json_exception</span></a>, <a class="reference internal" href="#classdolbyio_1_1comms_1_1jwt__exception"><span class="std std-ref">dolbyio::comms::jwt_exception</span></a>, <a class="reference internal" href="#classdolbyio_1_1comms_1_1media__exception"><span class="std std-ref">dolbyio::comms::media_exception</span></a>, <a class="reference internal" href="../processor.html#classdolbyio_1_1comms_1_1plugin_1_1video__processor_1_1exception"><span class="std std-ref">dolbyio::comms::plugin::video_processor::exception</span></a>, <a class="reference internal" href="#classdolbyio_1_1comms_1_1session__exception"><span class="std std-ref">dolbyio::comms::session_exception</span></a>, <a class="reference internal" href="#classdolbyio_1_1comms_1_1spatial__placement__exception"><span class="std std-ref">dolbyio::comms::spatial_placement_exception</span></a></p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms9exception9exceptionERKNSt6stringE">
<span id="_CPPv3N7dolbyio5comms9exception9exceptionERKNSt6stringE"></span><span id="_CPPv2N7dolbyio5comms9exception9exceptionERKNSt6stringE"></span><span id="dolbyio::comms::exception::exception__ssCR"></span><span class="target" id="classdolbyio_1_1comms_1_1exception_1addae96de76973d1b538227d243e83a04"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">exception</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">description</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N7dolbyio5comms9exception9exceptionERKNSt6stringE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The constructor that takes the description of the exception. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>description</strong> – A string indicating a reason for the exception. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK7dolbyio5comms9exception4whatEv">
<span id="_CPPv3NK7dolbyio5comms9exception4whatEv"></span><span id="_CPPv2NK7dolbyio5comms9exception4whatEv"></span><span id="dolbyio::comms::exception::whatC"></span><span class="target" id="classdolbyio_1_1comms_1_1exception_1a2c75f2642c4a2e9938cf3ad885847701"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">what</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="k"><span class="pre">noexcept</span></span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4NK7dolbyio5comms9exception4whatEv" title="Permalink to this definition"></a><br /></dt>
<dd><p>Overrides to std::exception that returns a description of the exception. </p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>A string that describes the exception. </p>
</dd>
</dl>
</dd></dl>
</div>
</dd></dl>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms24async_operation_canceledE">
<span id="_CPPv3N7dolbyio5comms24async_operation_canceledE"></span><span id="_CPPv2N7dolbyio5comms24async_operation_canceledE"></span><span id="dolbyio::comms::async_operation_canceled"></span><span class="target" id="classdolbyio_1_1comms_1_1async__operation__canceled"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">async_operation_canceled</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">dolbyio</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">comms</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N7dolbyio5comms9exceptionE" title="dolbyio::comms::exception"><span class="n"><span class="pre">exception</span></span></a><a class="headerlink" href="#_CPPv4N7dolbyio5comms24async_operation_canceledE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The base class that describes exceptions that are thrown when an asynchronous operation is abruptly canceled. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms24async_operation_canceled24async_operation_canceledERKNSt6stringE">
<span id="_CPPv3N7dolbyio5comms24async_operation_canceled24async_operation_canceledERKNSt6stringE"></span><span id="_CPPv2N7dolbyio5comms24async_operation_canceled24async_operation_canceledERKNSt6stringE"></span><span id="dolbyio::comms::async_operation_canceled::async_operation_canceled__ssCR"></span><span class="target" id="classdolbyio_1_1comms_1_1async__operation__canceled_1a9eeaca362ab490e6e879b935b126dd6e"></span><span class="sig-name descname"><span class="n"><span class="pre">async_operation_canceled</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">reason</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N7dolbyio5comms24async_operation_canceled24async_operation_canceledERKNSt6stringE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The constructor that takes a reason for failure. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>reason</strong> – A string that indicates a reason for failure. </p>
</dd>
</dl>
</dd></dl>
</div>
</dd></dl>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms19dvc_error_exceptionE">
<span id="_CPPv3N7dolbyio5comms19dvc_error_exceptionE"></span><span id="_CPPv2N7dolbyio5comms19dvc_error_exceptionE"></span><span id="dolbyio::comms::dvc_error_exception"></span><span class="target" id="classdolbyio_1_1comms_1_1dvc__error__exception"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">dvc_error_exception</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">dolbyio</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">comms</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N7dolbyio5comms22media_engine_exceptionE" title="dolbyio::comms::media_engine_exception"><span class="n"><span class="pre">media_engine_exception</span></span></a><a class="headerlink" href="#_CPPv4N7dolbyio5comms19dvc_error_exceptionE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The class that describes a conference error which originates in the DVC library. This exception can also be listened for by attaching a handler for the <a class="reference internal" href="#classdolbyio_1_1comms_1_1dvc__error__exception"><span class="std std-ref">dvc_error_exception</span></a> type through the Conference Service. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms19dvc_error_exception19dvc_error_exceptionERKNSt6stringE">
<span id="_CPPv3N7dolbyio5comms19dvc_error_exception19dvc_error_exceptionERKNSt6stringE"></span><span id="_CPPv2N7dolbyio5comms19dvc_error_exception19dvc_error_exceptionERKNSt6stringE"></span><span id="dolbyio::comms::dvc_error_exception::dvc_error_exception__ssCR"></span><span class="target" id="classdolbyio_1_1comms_1_1dvc__error__exception_1a30743d8bdb49a7c1d09df30ee73990b0"></span><span class="sig-name descname"><span class="n"><span class="pre">dvc_error_exception</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">reason</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N7dolbyio5comms19dvc_error_exception19dvc_error_exceptionERKNSt6stringE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The constructor that takes a reason for the DVC error. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>reason</strong> – Describes in detail why the error occurred. </p>
</dd>
</dl>
</dd></dl>
</div>
</dd></dl>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms14json_exceptionE">
<span id="_CPPv3N7dolbyio5comms14json_exceptionE"></span><span id="_CPPv2N7dolbyio5comms14json_exceptionE"></span><span id="dolbyio::comms::json_exception"></span><span class="target" id="classdolbyio_1_1comms_1_1json__exception"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">json_exception</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">dolbyio</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">comms</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N7dolbyio5comms9exceptionE" title="dolbyio::comms::exception"><span class="n"><span class="pre">exception</span></span></a><a class="headerlink" href="#_CPPv4N7dolbyio5comms14json_exceptionE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The base class for the JSON and depicts exceptions that are thrown when there is a JSON parsing error. This means an error in serializing or deserializing JSON string or object. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms14json_exception14json_exceptionERRNSt6stringERRNSt6stringE">
<span id="_CPPv3N7dolbyio5comms14json_exception14json_exceptionERRNSt6stringERRNSt6stringE"></span><span id="_CPPv2N7dolbyio5comms14json_exception14json_exceptionERRNSt6stringERRNSt6stringE"></span><span id="dolbyio::comms::json_exception::json_exception__ssRR.ssRR"></span><span class="target" id="classdolbyio_1_1comms_1_1json__exception_1a933c61f8a07942dc4429b2de0ff4b4c0"></span><span class="sig-name descname"><span class="n"><span class="pre">json_exception</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">description</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">path</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N7dolbyio5comms14json_exception14json_exceptionERRNSt6stringERRNSt6stringE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The constructor that takes a description of the exception. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>description</strong> – The description of the exception. </p></li>
<li><p><strong>path</strong> – JSON object path </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK7dolbyio5comms14json_exception4pathEv">
<span id="_CPPv3NK7dolbyio5comms14json_exception4pathEv"></span><span id="_CPPv2NK7dolbyio5comms14json_exception4pathEv"></span><span id="dolbyio::comms::json_exception::pathC"></span><span class="target" id="classdolbyio_1_1comms_1_1json__exception_1ab49ad43e658e065f3ace0d710e1d15ed"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="sig-name descname"><span class="n"><span class="pre">path</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="k"><span class="pre">noexcept</span></span><a class="headerlink" href="#_CPPv4NK7dolbyio5comms14json_exception4pathEv" title="Permalink to this definition"></a><br /></dt>
<dd><p>The accessor that returns the full path of the exception. </p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>A string that contains a full path of the exception. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK7dolbyio5comms14json_exception4descEv">
<span id="_CPPv3NK7dolbyio5comms14json_exception4descEv"></span><span id="_CPPv2NK7dolbyio5comms14json_exception4descEv"></span><span id="dolbyio::comms::json_exception::descC"></span><span class="target" id="classdolbyio_1_1comms_1_1json__exception_1ab0482455f84bc53480f50959e54defc9"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="sig-name descname"><span class="n"><span class="pre">desc</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="k"><span class="pre">noexcept</span></span><a class="headerlink" href="#_CPPv4NK7dolbyio5comms14json_exception4descEv" title="Permalink to this definition"></a><br /></dt>
<dd><p>The accessor that returns a description of the exception string. </p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>A string that contains a description of the exception. </p>
</dd>
</dl>
</dd></dl>
</div>
</dd></dl>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms13jwt_exceptionE">
<span id="_CPPv3N7dolbyio5comms13jwt_exceptionE"></span><span id="_CPPv2N7dolbyio5comms13jwt_exceptionE"></span><span id="dolbyio::comms::jwt_exception"></span><span class="target" id="classdolbyio_1_1comms_1_1jwt__exception"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">jwt_exception</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">dolbyio</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">comms</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N7dolbyio5comms9exceptionE" title="dolbyio::comms::exception"><span class="n"><span class="pre">exception</span></span></a><a class="headerlink" href="#_CPPv4N7dolbyio5comms13jwt_exceptionE" title="Permalink to this definition"></a><br /></dt>
<dd><p>Describes the JSON web token exceptions indicating that the authentication web token is not correct. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms13jwt_exception13jwt_exceptionERKNSt6stringE">
<span id="_CPPv3N7dolbyio5comms13jwt_exception13jwt_exceptionERKNSt6stringE"></span><span id="_CPPv2N7dolbyio5comms13jwt_exception13jwt_exceptionERKNSt6stringE"></span><span id="dolbyio::comms::jwt_exception::jwt_exception__ssCR"></span><span class="target" id="classdolbyio_1_1comms_1_1jwt__exception_1a2844f4bd89543ac81138fa46f5867893"></span><span class="sig-name descname"><span class="n"><span class="pre">jwt_exception</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">jwt_body</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N7dolbyio5comms13jwt_exception13jwt_exceptionERKNSt6stringE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The constructor that takes the body of the token. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>jwt_body</strong> – The body of the web token. </p>
</dd>
</dl>
</dd></dl>
</div>
</dd></dl>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms12io_exceptionE">
<span id="_CPPv3N7dolbyio5comms12io_exceptionE"></span><span id="_CPPv2N7dolbyio5comms12io_exceptionE"></span><span id="dolbyio::comms::io_exception"></span><span class="target" id="classdolbyio_1_1comms_1_1io__exception"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">io_exception</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">dolbyio</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">comms</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N7dolbyio5comms9exceptionE" title="dolbyio::comms::exception"><span class="n"><span class="pre">exception</span></span></a><a class="headerlink" href="#_CPPv4N7dolbyio5comms12io_exceptionE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The base class for all IO exceptions that occur in the case of problems with opening sockets or files. </p>
<p>Subclassed by <a class="reference internal" href="#classdolbyio_1_1comms_1_1http__exception"><span class="std std-ref">dolbyio::comms::http_exception</span></a>, <a class="reference internal" href="#classdolbyio_1_1comms_1_1restapi__exception"><span class="std std-ref">dolbyio::comms::restapi_exception</span></a>, <a class="reference internal" href="#classdolbyio_1_1comms_1_1security__check__exception"><span class="std std-ref">dolbyio::comms::security_check_exception</span></a>, <a class="reference internal" href="#classdolbyio_1_1comms_1_1signaling__channel__exception"><span class="std std-ref">dolbyio::comms::signaling_channel_exception</span></a></p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms12io_exception12io_exceptionERKNSt6stringE">
<span id="_CPPv3N7dolbyio5comms12io_exception12io_exceptionERKNSt6stringE"></span><span id="_CPPv2N7dolbyio5comms12io_exception12io_exceptionERKNSt6stringE"></span><span id="dolbyio::comms::io_exception::io_exception__ssCR"></span><span class="target" id="classdolbyio_1_1comms_1_1io__exception_1a850158417810ffdd72fdabf45fced2ca"></span><span class="sig-name descname"><span class="n"><span class="pre">io_exception</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">description</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N7dolbyio5comms12io_exception12io_exceptionERKNSt6stringE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The constructor that takes the description of the exception. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>description</strong> – A string that describes the exception. </p>
</dd>
</dl>
</dd></dl>
</div>
</dd></dl>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms14http_exceptionE">
<span id="_CPPv3N7dolbyio5comms14http_exceptionE"></span><span id="_CPPv2N7dolbyio5comms14http_exceptionE"></span><span id="dolbyio::comms::http_exception"></span><span class="target" id="classdolbyio_1_1comms_1_1http__exception"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">http_exception</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">dolbyio</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">comms</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N7dolbyio5comms12io_exceptionE" title="dolbyio::comms::io_exception"><span class="n"><span class="pre">io_exception</span></span></a><a class="headerlink" href="#_CPPv4N7dolbyio5comms14http_exceptionE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The class that describes the HTTP errors. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms14http_exception14http_exceptionEi">
<span id="_CPPv3N7dolbyio5comms14http_exception14http_exceptionEi"></span><span id="_CPPv2N7dolbyio5comms14http_exception14http_exceptionEi"></span><span id="dolbyio::comms::http_exception::http_exception__i"></span><span class="target" id="classdolbyio_1_1comms_1_1http__exception_1ae09eaf2ac354d8f0986cde1b05e2e8ef"></span><span class="sig-name descname"><span class="n"><span class="pre">http_exception</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">code</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N7dolbyio5comms14http_exception14http_exceptionEi" title="Permalink to this definition"></a><br /></dt>
<dd><p>The constructor that takes the HTTP error code. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>code</strong> – The HTTP error code. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK7dolbyio5comms14http_exception9http_codeEv">
<span id="_CPPv3NK7dolbyio5comms14http_exception9http_codeEv"></span><span id="_CPPv2NK7dolbyio5comms14http_exception9http_codeEv"></span><span id="dolbyio::comms::http_exception::http_codeC"></span><span class="target" id="classdolbyio_1_1comms_1_1http__exception_1aa9325cd9b5b327249de9bc716a085ce8"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">http_code</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="k"><span class="pre">noexcept</span></span><a class="headerlink" href="#_CPPv4NK7dolbyio5comms14http_exception9http_codeEv" title="Permalink to this definition"></a><br /></dt>
<dd><p>The accessor that returns the HTTP error code of the exception. </p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>An integer value that represents the HTTP error code. </p>
</dd>
</dl>
</dd></dl>
</div>
</dd></dl>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms17restapi_exceptionE">
<span id="_CPPv3N7dolbyio5comms17restapi_exceptionE"></span><span id="_CPPv2N7dolbyio5comms17restapi_exceptionE"></span><span id="dolbyio::comms::restapi_exception"></span><span class="target" id="classdolbyio_1_1comms_1_1restapi__exception"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">restapi_exception</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">dolbyio</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">comms</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N7dolbyio5comms12io_exceptionE" title="dolbyio::comms::io_exception"><span class="n"><span class="pre">io_exception</span></span></a><a class="headerlink" href="#_CPPv4N7dolbyio5comms17restapi_exceptionE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The class that describes errors received from the backend service during REST API calls. </p>
<p>Subclassed by <a class="reference internal" href="#classdolbyio_1_1comms_1_1invalid__token__exception"><span class="std std-ref">dolbyio::comms::invalid_token_exception</span></a></p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms17restapi_exception17restapi_exceptionEiiRKNSt6stringERKNSt6stringE">
<span id="_CPPv3N7dolbyio5comms17restapi_exception17restapi_exceptionEiiRKNSt6stringERKNSt6stringE"></span><span id="_CPPv2N7dolbyio5comms17restapi_exception17restapi_exceptionEiiRKNSt6stringERKNSt6stringE"></span><span id="dolbyio::comms::restapi_exception::restapi_exception__i.i.ssCR.ssCR"></span><span class="target" id="classdolbyio_1_1comms_1_1restapi__exception_1a97e44a8a99b23a189e89e64a8e8f4c43"></span><span class="sig-name descname"><span class="n"><span class="pre">restapi_exception</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">http_code</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">rest_code</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">err_reason</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">err_description</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N7dolbyio5comms17restapi_exception17restapi_exceptionEiiRKNSt6stringERKNSt6stringE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The constructor that takes the error code, reason, and description of the error from a server response. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>http_code</strong> – The HTTP code. </p></li>
<li><p><strong>rest_code</strong> – The REST API code. </p></li>
<li><p><strong>err_reason</strong> – The reason for the error. </p></li>
<li><p><strong>err_description</strong> – The error description. </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK7dolbyio5comms17restapi_exception9http_codeEv">
<span id="_CPPv3NK7dolbyio5comms17restapi_exception9http_codeEv"></span><span id="_CPPv2NK7dolbyio5comms17restapi_exception9http_codeEv"></span><span id="dolbyio::comms::restapi_exception::http_codeC"></span><span class="target" id="classdolbyio_1_1comms_1_1restapi__exception_1ac53605708d8d96aa3f77713e100468ec"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">http_code</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="k"><span class="pre">noexcept</span></span><a class="headerlink" href="#_CPPv4NK7dolbyio5comms17restapi_exception9http_codeEv" title="Permalink to this definition"></a><br /></dt>
<dd><p>The accessor for the HTTP code of the exception. </p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>An integer that represents the HTTP code. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK7dolbyio5comms17restapi_exception9rest_codeEv">
<span id="_CPPv3NK7dolbyio5comms17restapi_exception9rest_codeEv"></span><span id="_CPPv2NK7dolbyio5comms17restapi_exception9rest_codeEv"></span><span id="dolbyio::comms::restapi_exception::rest_codeC"></span><span class="target" id="classdolbyio_1_1comms_1_1restapi__exception_1acfa4847b45f4520313495daf1371e139"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">rest_code</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="k"><span class="pre">noexcept</span></span><a class="headerlink" href="#_CPPv4NK7dolbyio5comms17restapi_exception9rest_codeEv" title="Permalink to this definition"></a><br /></dt>
<dd><p>The accessor for the REST code of the exception. </p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>An integer that represents the REST error code. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK7dolbyio5comms17restapi_exception6reasonEv">
<span id="_CPPv3NK7dolbyio5comms17restapi_exception6reasonEv"></span><span id="_CPPv2NK7dolbyio5comms17restapi_exception6reasonEv"></span><span id="dolbyio::comms::restapi_exception::reasonC"></span><span class="target" id="classdolbyio_1_1comms_1_1restapi__exception_1a78c983662db4b2d2ccf697efee67b504"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="sig-name descname"><span class="n"><span class="pre">reason</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="k"><span class="pre">noexcept</span></span><a class="headerlink" href="#_CPPv4NK7dolbyio5comms17restapi_exception6reasonEv" title="Permalink to this definition"></a><br /></dt>
<dd><p>The accessor for the reason of the error. </p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>A string that contains the reason for the error returned in the REST response. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK7dolbyio5comms17restapi_exception11descriptionEv">
<span id="_CPPv3NK7dolbyio5comms17restapi_exception11descriptionEv"></span><span id="_CPPv2NK7dolbyio5comms17restapi_exception11descriptionEv"></span><span id="dolbyio::comms::restapi_exception::descriptionC"></span><span class="target" id="classdolbyio_1_1comms_1_1restapi__exception_1afa8dfa525cf496dfd7603e23b863c7df"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="sig-name descname"><span class="n"><span class="pre">description</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="k"><span class="pre">noexcept</span></span><a class="headerlink" href="#_CPPv4NK7dolbyio5comms17restapi_exception11descriptionEv" title="Permalink to this definition"></a><br /></dt>
<dd><p>The accessor for the error description. </p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>A string that contains the description of the error returned in the REST response. </p>
</dd>
</dl>
</dd></dl>
</div>
</dd></dl>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms17session_exceptionE">
<span id="_CPPv3N7dolbyio5comms17session_exceptionE"></span><span id="_CPPv2N7dolbyio5comms17session_exceptionE"></span><span id="dolbyio::comms::session_exception"></span><span class="target" id="classdolbyio_1_1comms_1_1session__exception"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">session_exception</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">dolbyio</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">comms</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N7dolbyio5comms9exceptionE" title="dolbyio::comms::exception"><span class="n"><span class="pre">exception</span></span></a><a class="headerlink" href="#_CPPv4N7dolbyio5comms17session_exceptionE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The class that describes errors related to the Session Service. </p>
<p>Subclassed by <a class="reference internal" href="../session.html#classdolbyio_1_1comms_1_1services_1_1session_1_1state__exception"><span class="std std-ref">dolbyio::comms::services::session::state_exception</span></a></p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms17session_exception17session_exceptionERKNSt6stringE">
<span id="_CPPv3N7dolbyio5comms17session_exception17session_exceptionERKNSt6stringE"></span><span id="_CPPv2N7dolbyio5comms17session_exception17session_exceptionERKNSt6stringE"></span><span id="dolbyio::comms::session_exception::session_exception__ssCR"></span><span class="target" id="classdolbyio_1_1comms_1_1session__exception_1a546c9c6962674dc6caee6931933077ec"></span><span class="sig-name descname"><span class="n"><span class="pre">session_exception</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">description</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N7dolbyio5comms17session_exception17session_exceptionERKNSt6stringE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The constructor that takes the error description. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>description</strong> – A string that describes the exception. </p>
</dd>
</dl>
</dd></dl>
</div>
</dd></dl>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms20conference_exceptionE">
<span id="_CPPv3N7dolbyio5comms20conference_exceptionE"></span><span id="_CPPv2N7dolbyio5comms20conference_exceptionE"></span><span id="dolbyio::comms::conference_exception"></span><span class="target" id="classdolbyio_1_1comms_1_1conference__exception"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">conference_exception</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">dolbyio</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">comms</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N7dolbyio5comms9exceptionE" title="dolbyio::comms::exception"><span class="n"><span class="pre">exception</span></span></a><a class="headerlink" href="#_CPPv4N7dolbyio5comms20conference_exceptionE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The class that describes errors that occur in an active conference. </p>
<p>Subclassed by <a class="reference internal" href="#classdolbyio_1_1comms_1_1conference__state__exception"><span class="std std-ref">dolbyio::comms::conference_state_exception</span></a>, <a class="reference internal" href="#classdolbyio_1_1comms_1_1media__engine__exception"><span class="std std-ref">dolbyio::comms::media_engine_exception</span></a></p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms20conference_exception20conference_exceptionERKNSt6stringE">
<span id="_CPPv3N7dolbyio5comms20conference_exception20conference_exceptionERKNSt6stringE"></span><span id="_CPPv2N7dolbyio5comms20conference_exception20conference_exceptionERKNSt6stringE"></span><span id="dolbyio::comms::conference_exception::conference_exception__ssCR"></span><span class="target" id="classdolbyio_1_1comms_1_1conference__exception_1a51fc206b7ee891e0ca061b216fb7d225"></span><span class="sig-name descname"><span class="n"><span class="pre">conference_exception</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">description</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N7dolbyio5comms20conference_exception20conference_exceptionERKNSt6stringE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The constructor that takes the exception description. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>description</strong> – The description of the exception. </p>
</dd>
</dl>
</dd></dl>
</div>
</dd></dl>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms26conference_state_exceptionE">
<span id="_CPPv3N7dolbyio5comms26conference_state_exceptionE"></span><span id="_CPPv2N7dolbyio5comms26conference_state_exceptionE"></span><span id="dolbyio::comms::conference_state_exception"></span><span class="target" id="classdolbyio_1_1comms_1_1conference__state__exception"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">conference_state_exception</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">dolbyio</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">comms</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N7dolbyio5comms20conference_exceptionE" title="dolbyio::comms::conference_exception"><span class="n"><span class="pre">conference_exception</span></span></a><a class="headerlink" href="#_CPPv4N7dolbyio5comms26conference_state_exceptionE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The class that describes errors for attempted operations that require a different conference state. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms26conference_state_exception26conference_state_exceptionERKNSt6stringERKNSt6stringE">
<span id="_CPPv3N7dolbyio5comms26conference_state_exception26conference_state_exceptionERKNSt6stringERKNSt6stringE"></span><span id="_CPPv2N7dolbyio5comms26conference_state_exception26conference_state_exceptionERKNSt6stringERKNSt6stringE"></span><span id="dolbyio::comms::conference_state_exception::conference_state_exception__ssCR.ssCR"></span><span class="target" id="classdolbyio_1_1comms_1_1conference__state__exception_1a825f9b15c9bc8d2553353fa834041a0b"></span><span class="sig-name descname"><span class="n"><span class="pre">conference_state_exception</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">current</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">required</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N7dolbyio5comms26conference_state_exception26conference_state_exceptionERKNSt6stringERKNSt6stringE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The constructor that takes the current the required state. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>current</strong> – The current state of a conference. </p></li>
<li><p><strong>required</strong> – The required state of a conference. </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK7dolbyio5comms26conference_state_exception13current_stateEv">
<span id="_CPPv3NK7dolbyio5comms26conference_state_exception13current_stateEv"></span><span id="_CPPv2NK7dolbyio5comms26conference_state_exception13current_stateEv"></span><span id="dolbyio::comms::conference_state_exception::current_stateC"></span><span class="target" id="classdolbyio_1_1comms_1_1conference__state__exception_1a056c77953354cbe0d2ec7ef11054877e"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="sig-name descname"><span class="n"><span class="pre">current_state</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="k"><span class="pre">noexcept</span></span><a class="headerlink" href="#_CPPv4NK7dolbyio5comms26conference_state_exception13current_stateEv" title="Permalink to this definition"></a><br /></dt>
<dd><p>Returns the current state of a conference that is stored in the exception. </p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The current session state. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK7dolbyio5comms26conference_state_exception14required_stateEv">
<span id="_CPPv3NK7dolbyio5comms26conference_state_exception14required_stateEv"></span><span id="_CPPv2NK7dolbyio5comms26conference_state_exception14required_stateEv"></span><span id="dolbyio::comms::conference_state_exception::required_stateC"></span><span class="target" id="classdolbyio_1_1comms_1_1conference__state__exception_1a806729ddc8ed41e38b150f2d3dc11b14"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="sig-name descname"><span class="n"><span class="pre">required_state</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="k"><span class="pre">noexcept</span></span><a class="headerlink" href="#_CPPv4NK7dolbyio5comms26conference_state_exception14required_stateEv" title="Permalink to this definition"></a><br /></dt>
<dd><p>Returns the required state of a conference that is stored in the exception. </p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>A string that contains the required state of a conference. </p>
</dd>
</dl>
</dd></dl>
</div>
</dd></dl>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms15media_exceptionE">
<span id="_CPPv3N7dolbyio5comms15media_exceptionE"></span><span id="_CPPv2N7dolbyio5comms15media_exceptionE"></span><span id="dolbyio::comms::media_exception"></span><span class="target" id="classdolbyio_1_1comms_1_1media__exception"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">media_exception</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">dolbyio</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">comms</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N7dolbyio5comms9exceptionE" title="dolbyio::comms::exception"><span class="n"><span class="pre">exception</span></span></a><a class="headerlink" href="#_CPPv4N7dolbyio5comms15media_exceptionE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The base exception class for exceptions originating from the media_engine. </p>
<p>Subclassed by <a class="reference internal" href="#classdolbyio_1_1comms_1_1dvc__exception"><span class="std std-ref">dolbyio::comms::dvc_exception</span></a></p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms15media_exception15media_exceptionERRNSt6stringE">
<span id="_CPPv3N7dolbyio5comms15media_exception15media_exceptionERRNSt6stringE"></span><span id="_CPPv2N7dolbyio5comms15media_exception15media_exceptionERRNSt6stringE"></span><span id="dolbyio::comms::media_exception::media_exception__ssRR"></span><span class="target" id="classdolbyio_1_1comms_1_1media__exception_1a85b49f4ae31e618ff76f99e44b827318"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">media_exception</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">description</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N7dolbyio5comms15media_exception15media_exceptionERRNSt6stringE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The constructor that takes a description of the exception. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>description</strong> – The description of the exception. </p>
</dd>
</dl>
</dd></dl>
</div>
</dd></dl>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms22media_engine_exceptionE">
<span id="_CPPv3N7dolbyio5comms22media_engine_exceptionE"></span><span id="_CPPv2N7dolbyio5comms22media_engine_exceptionE"></span><span id="dolbyio::comms::media_engine_exception"></span><span class="target" id="classdolbyio_1_1comms_1_1media__engine__exception"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">media_engine_exception</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">dolbyio</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">comms</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N7dolbyio5comms20conference_exceptionE" title="dolbyio::comms::conference_exception"><span class="n"><span class="pre">conference_exception</span></span></a><a class="headerlink" href="#_CPPv4N7dolbyio5comms22media_engine_exceptionE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The base class describing exceptions stemming from media engine. </p>
<p>Subclassed by <a class="reference internal" href="#classdolbyio_1_1comms_1_1create__answer__exception"><span class="std std-ref">dolbyio::comms::create_answer_exception</span></a>, <a class="reference internal" href="#classdolbyio_1_1comms_1_1create__peer__connection__exception"><span class="std std-ref">dolbyio::comms::create_peer_connection_exception</span></a>, <a class="reference internal" href="#classdolbyio_1_1comms_1_1dvc__error__exception"><span class="std std-ref">dolbyio::comms::dvc_error_exception</span></a>, <a class="reference internal" href="#classdolbyio_1_1comms_1_1ice__candidate__exception"><span class="std std-ref">dolbyio::comms::ice_candidate_exception</span></a>, <a class="reference internal" href="#classdolbyio_1_1comms_1_1media__stream__exception"><span class="std std-ref">dolbyio::comms::media_stream_exception</span></a>, <a class="reference internal" href="#classdolbyio_1_1comms_1_1peer__connection__disconnected__exception"><span class="std std-ref">dolbyio::comms::peer_connection_disconnected_exception</span></a>, <a class="reference internal" href="#classdolbyio_1_1comms_1_1peer__connection__failed__exception"><span class="std std-ref">dolbyio::comms::peer_connection_failed_exception</span></a>, <a class="reference internal" href="#classdolbyio_1_1comms_1_1sdp__exception"><span class="std std-ref">dolbyio::comms::sdp_exception</span></a></p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms22media_engine_exception22media_engine_exceptionERKNSt6stringE">
<span id="_CPPv3N7dolbyio5comms22media_engine_exception22media_engine_exceptionERKNSt6stringE"></span><span id="_CPPv2N7dolbyio5comms22media_engine_exception22media_engine_exceptionERKNSt6stringE"></span><span id="dolbyio::comms::media_engine_exception::media_engine_exception__ssCR"></span><span class="target" id="classdolbyio_1_1comms_1_1media__engine__exception_1a166b384cb1d92cb5d2dfe584484c90fe"></span><span class="sig-name descname"><span class="n"><span class="pre">media_engine_exception</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">reason</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N7dolbyio5comms22media_engine_exception22media_engine_exceptionERKNSt6stringE" title="Permalink to this definition"></a><br /></dt>
<dd><p><a class="reference internal" href="#classdolbyio_1_1comms_1_1media__engine__exception"><span class="std std-ref">media_engine_exception</span></a> constructor </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>reason</strong> – describing the media engine exception. </p>
</dd>
</dl>
</dd></dl>
</div>
</dd></dl>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms23create_answer_exceptionE">
<span id="_CPPv3N7dolbyio5comms23create_answer_exceptionE"></span><span id="_CPPv2N7dolbyio5comms23create_answer_exceptionE"></span><span id="dolbyio::comms::create_answer_exception"></span><span class="target" id="classdolbyio_1_1comms_1_1create__answer__exception"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">create_answer_exception</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">dolbyio</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">comms</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N7dolbyio5comms22media_engine_exceptionE" title="dolbyio::comms::media_engine_exception"><span class="n"><span class="pre">media_engine_exception</span></span></a><a class="headerlink" href="#_CPPv4N7dolbyio5comms23create_answer_exceptionE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The class that describes conference error where the WebRTC is unable to create an answer for the received offer. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms23create_answer_exception23create_answer_exceptionERKNSt6stringE">
<span id="_CPPv3N7dolbyio5comms23create_answer_exception23create_answer_exceptionERKNSt6stringE"></span><span id="_CPPv2N7dolbyio5comms23create_answer_exception23create_answer_exceptionERKNSt6stringE"></span><span id="dolbyio::comms::create_answer_exception::create_answer_exception__ssCR"></span><span class="target" id="classdolbyio_1_1comms_1_1create__answer__exception_1a2a2d36fd2c7a5bc5daeed26af58a448f"></span><span class="sig-name descname"><span class="n"><span class="pre">create_answer_exception</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">reason</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N7dolbyio5comms23create_answer_exception23create_answer_exceptionERKNSt6stringE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The constructor that takes a reason for error. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>reason</strong> – Describes in detail the reason for failing to create answer. </p>
</dd>
</dl>
</dd></dl>
</div>
</dd></dl>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms32create_peer_connection_exceptionE">
<span id="_CPPv3N7dolbyio5comms32create_peer_connection_exceptionE"></span><span id="_CPPv2N7dolbyio5comms32create_peer_connection_exceptionE"></span><span id="dolbyio::comms::create_peer_connection_exception"></span><span class="target" id="classdolbyio_1_1comms_1_1create__peer__connection__exception"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">create_peer_connection_exception</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">dolbyio</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">comms</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N7dolbyio5comms22media_engine_exceptionE" title="dolbyio::comms::media_engine_exception"><span class="n"><span class="pre">media_engine_exception</span></span></a><a class="headerlink" href="#_CPPv4N7dolbyio5comms32create_peer_connection_exceptionE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The class that describes a conferencing error which may occur during a creation of an initial peer connection. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms32create_peer_connection_exception32create_peer_connection_exceptionEv">
<span id="_CPPv3N7dolbyio5comms32create_peer_connection_exception32create_peer_connection_exceptionEv"></span><span id="_CPPv2N7dolbyio5comms32create_peer_connection_exception32create_peer_connection_exceptionEv"></span><span id="dolbyio::comms::create_peer_connection_exception::create_peer_connection_exception"></span><span class="target" id="classdolbyio_1_1comms_1_1create__peer__connection__exception_1ab9bd52e804597ecef1952e59869203d3"></span><span class="sig-name descname"><span class="n"><span class="pre">create_peer_connection_exception</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N7dolbyio5comms32create_peer_connection_exception32create_peer_connection_exceptionEv" title="Permalink to this definition"></a><br /></dt>
<dd><p>The default constructor. </p>
</dd></dl>
</div>
</dd></dl>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms23ice_candidate_exceptionE">
<span id="_CPPv3N7dolbyio5comms23ice_candidate_exceptionE"></span><span id="_CPPv2N7dolbyio5comms23ice_candidate_exceptionE"></span><span id="dolbyio::comms::ice_candidate_exception"></span><span class="target" id="classdolbyio_1_1comms_1_1ice__candidate__exception"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ice_candidate_exception</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">dolbyio</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">comms</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N7dolbyio5comms22media_engine_exceptionE" title="dolbyio::comms::media_engine_exception"><span class="n"><span class="pre">media_engine_exception</span></span></a><a class="headerlink" href="#_CPPv4N7dolbyio5comms23ice_candidate_exceptionE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The class that describes a conferencing error which can occur during an initial setting of candidates for a connection when the remote description is successfully applied. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms23ice_candidate_exception23ice_candidate_exceptionERKNSt6stringE">
<span id="_CPPv3N7dolbyio5comms23ice_candidate_exception23ice_candidate_exceptionERKNSt6stringE"></span><span id="_CPPv2N7dolbyio5comms23ice_candidate_exception23ice_candidate_exceptionERKNSt6stringE"></span><span id="dolbyio::comms::ice_candidate_exception::ice_candidate_exception__ssCR"></span><span class="target" id="classdolbyio_1_1comms_1_1ice__candidate__exception_1abbb1a4d173bc2176c332071ded8cec0f"></span><span class="sig-name descname"><span class="n"><span class="pre">ice_candidate_exception</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">reason</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N7dolbyio5comms23ice_candidate_exception23ice_candidate_exceptionERKNSt6stringE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The constructor that takes the reason for error. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>reason</strong> – Describes in detail the reason for the ice candidate error. </p>
</dd>
</dl>
</dd></dl>
</div>
</dd></dl>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms22media_stream_exceptionE">
<span id="_CPPv3N7dolbyio5comms22media_stream_exceptionE"></span><span id="_CPPv2N7dolbyio5comms22media_stream_exceptionE"></span><span id="dolbyio::comms::media_stream_exception"></span><span class="target" id="classdolbyio_1_1comms_1_1media__stream__exception"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">media_stream_exception</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">dolbyio</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">comms</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N7dolbyio5comms22media_engine_exceptionE" title="dolbyio::comms::media_engine_exception"><span class="n"><span class="pre">media_engine_exception</span></span></a><a class="headerlink" href="#_CPPv4N7dolbyio5comms22media_stream_exceptionE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The exception that indicates an issue with the local media stream. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms22media_stream_exception22media_stream_exceptionEv">
<span id="_CPPv3N7dolbyio5comms22media_stream_exception22media_stream_exceptionEv"></span><span id="_CPPv2N7dolbyio5comms22media_stream_exception22media_stream_exceptionEv"></span><span id="dolbyio::comms::media_stream_exception::media_stream_exception"></span><span class="target" id="classdolbyio_1_1comms_1_1media__stream__exception_1a7d88e3eacbca3a150f4910f5891498fe"></span><span class="sig-name descname"><span class="n"><span class="pre">media_stream_exception</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N7dolbyio5comms22media_stream_exception22media_stream_exceptionEv" title="Permalink to this definition"></a><br /></dt>
<dd><p>The default constructor for the error. </p>
</dd></dl>
</div>
</dd></dl>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms38peer_connection_disconnected_exceptionE">
<span id="_CPPv3N7dolbyio5comms38peer_connection_disconnected_exceptionE"></span><span id="_CPPv2N7dolbyio5comms38peer_connection_disconnected_exceptionE"></span><span id="dolbyio::comms::peer_connection_disconnected_exception"></span><span class="target" id="classdolbyio_1_1comms_1_1peer__connection__disconnected__exception"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">peer_connection_disconnected_exception</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">dolbyio</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">comms</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N7dolbyio5comms22media_engine_exceptionE" title="dolbyio::comms::media_engine_exception"><span class="n"><span class="pre">media_engine_exception</span></span></a><a class="headerlink" href="#_CPPv4N7dolbyio5comms38peer_connection_disconnected_exceptionE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The class that describes a conference error that results from a network connection issue. This error has a direct correlation with the disconnected PeerConnectionState. According to the WebRTC documentation, this state may be triggered intermittently and resolve without any action on less reliable networks. Therefore, this error is not considered fatal or non-recoverable like the PeerConnectionFailed state. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms38peer_connection_disconnected_exception38peer_connection_disconnected_exceptionERKNSt6stringE">
<span id="_CPPv3N7dolbyio5comms38peer_connection_disconnected_exception38peer_connection_disconnected_exceptionERKNSt6stringE"></span><span id="_CPPv2N7dolbyio5comms38peer_connection_disconnected_exception38peer_connection_disconnected_exceptionERKNSt6stringE"></span><span id="dolbyio::comms::peer_connection_disconnected_exception::peer_connection_disconnected_exception__ssCR"></span><span class="target" id="classdolbyio_1_1comms_1_1peer__connection__disconnected__exception_1ac2fe6ab62e0f1ebf5f91c3425d3c0871"></span><span class="sig-name descname"><span class="n"><span class="pre">peer_connection_disconnected_exception</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">reason</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N7dolbyio5comms38peer_connection_disconnected_exception38peer_connection_disconnected_exceptionERKNSt6stringE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The constructor that takes the reason for error. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>reason</strong> – Describes in detail the reason for the <a class="reference internal" href="#classdolbyio_1_1comms_1_1peer__connection__disconnected__exception"><span class="std std-ref">peer_connection_disconnected_exception</span></a>. </p>
</dd>
</dl>
</dd></dl>
</div>
</dd></dl>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms32peer_connection_failed_exceptionE">
<span id="_CPPv3N7dolbyio5comms32peer_connection_failed_exceptionE"></span><span id="_CPPv2N7dolbyio5comms32peer_connection_failed_exceptionE"></span><span id="dolbyio::comms::peer_connection_failed_exception"></span><span class="target" id="classdolbyio_1_1comms_1_1peer__connection__failed__exception"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">peer_connection_failed_exception</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">dolbyio</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">comms</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N7dolbyio5comms22media_engine_exceptionE" title="dolbyio::comms::media_engine_exception"><span class="n"><span class="pre">media_engine_exception</span></span></a><a class="headerlink" href="#_CPPv4N7dolbyio5comms32peer_connection_failed_exceptionE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The exception that is emitted when there is a failure detected with the peer connection to the server. Meaning One or more of the ICE transports on the connection is in the failed state. This error is strict and indicates that peer connection will not return to normal state. This exception can also be listened for by attaching a handler for the <a class="reference internal" href="#classdolbyio_1_1comms_1_1peer__connection__failed__exception"><span class="std std-ref">peer_connection_failed_exception</span></a> type through the Conference Service. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms32peer_connection_failed_exception32peer_connection_failed_exceptionERKNSt6stringE">
<span id="_CPPv3N7dolbyio5comms32peer_connection_failed_exception32peer_connection_failed_exceptionERKNSt6stringE"></span><span id="_CPPv2N7dolbyio5comms32peer_connection_failed_exception32peer_connection_failed_exceptionERKNSt6stringE"></span><span id="dolbyio::comms::peer_connection_failed_exception::peer_connection_failed_exception__ssCR"></span><span class="target" id="classdolbyio_1_1comms_1_1peer__connection__failed__exception_1a0b4e38e5f7f15b5b45b78c558021eca6"></span><span class="sig-name descname"><span class="n"><span class="pre">peer_connection_failed_exception</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">reason</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N7dolbyio5comms32peer_connection_failed_exception32peer_connection_failed_exceptionERKNSt6stringE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The constructor that takes a reason for failure. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>reason</strong> – Describes in detail why failure occurred. </p>
</dd>
</dl>
</dd></dl>
</div>
</dd></dl>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms13sdp_exceptionE">
<span id="_CPPv3N7dolbyio5comms13sdp_exceptionE"></span><span id="_CPPv2N7dolbyio5comms13sdp_exceptionE"></span><span id="dolbyio::comms::sdp_exception"></span><span class="target" id="classdolbyio_1_1comms_1_1sdp__exception"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">sdp_exception</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">dolbyio</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">comms</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N7dolbyio5comms22media_engine_exceptionE" title="dolbyio::comms::media_engine_exception"><span class="n"><span class="pre">media_engine_exception</span></span></a><a class="headerlink" href="#_CPPv4N7dolbyio5comms13sdp_exceptionE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The class that describes conferencing errors that occur when setting a remote description fails. This means that there is an incompatibility in the offer, for example, that the offer contains not supported codecs. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms13sdp_exception13sdp_exceptionERKNSt6stringE">
<span id="_CPPv3N7dolbyio5comms13sdp_exception13sdp_exceptionERKNSt6stringE"></span><span id="_CPPv2N7dolbyio5comms13sdp_exception13sdp_exceptionERKNSt6stringE"></span><span id="dolbyio::comms::sdp_exception::sdp_exception__ssCR"></span><span class="target" id="classdolbyio_1_1comms_1_1sdp__exception_1ae6bb40c0903e8bbeabc266146d48852c"></span><span class="sig-name descname"><span class="n"><span class="pre">sdp_exception</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">reason</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N7dolbyio5comms13sdp_exception13sdp_exceptionERKNSt6stringE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The constructor that takes a reason for error. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>reason</strong> – Describes in detail the reason for remote description setup failure. </p>
</dd>
</dl>
</dd></dl>
</div>
</dd></dl>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms27spatial_placement_exceptionE">
<span id="_CPPv3N7dolbyio5comms27spatial_placement_exceptionE"></span><span id="_CPPv2N7dolbyio5comms27spatial_placement_exceptionE"></span><span id="dolbyio::comms::spatial_placement_exception"></span><span class="target" id="classdolbyio_1_1comms_1_1spatial__placement__exception"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">spatial_placement_exception</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">dolbyio</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">comms</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N7dolbyio5comms9exceptionE" title="dolbyio::comms::exception"><span class="n"><span class="pre">exception</span></span></a><a class="headerlink" href="#_CPPv4N7dolbyio5comms27spatial_placement_exceptionE" title="Permalink to this definition"></a><br /></dt>
<dd><p>An error setting spatial coordinates. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms27spatial_placement_exception27spatial_placement_exceptionERKNSt6stringE">
<span id="_CPPv3N7dolbyio5comms27spatial_placement_exception27spatial_placement_exceptionERKNSt6stringE"></span><span id="_CPPv2N7dolbyio5comms27spatial_placement_exception27spatial_placement_exceptionERKNSt6stringE"></span><span id="dolbyio::comms::spatial_placement_exception::spatial_placement_exception__ssCR"></span><span class="target" id="classdolbyio_1_1comms_1_1spatial__placement__exception_1a45c3e4670bc49969a27868c498b5f8fd"></span><span class="sig-name descname"><span class="n"><span class="pre">spatial_placement_exception</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">description</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N7dolbyio5comms27spatial_placement_exception27spatial_placement_exceptionERKNSt6stringE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The constructor that takes the description of the exception. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>description</strong> – A string indicating a reason for the exception. </p>
</dd>
</dl>
</dd></dl>
</div>
</dd></dl>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms13dvc_exceptionE">
<span id="_CPPv3N7dolbyio5comms13dvc_exceptionE"></span><span id="_CPPv2N7dolbyio5comms13dvc_exceptionE"></span><span id="dolbyio::comms::dvc_exception"></span><span class="target" id="classdolbyio_1_1comms_1_1dvc__exception"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">dvc_exception</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">dolbyio</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">comms</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N7dolbyio5comms15media_exceptionE" title="dolbyio::comms::media_exception"><span class="n"><span class="pre">media_exception</span></span></a><a class="headerlink" href="#_CPPv4N7dolbyio5comms13dvc_exceptionE" title="Permalink to this definition"></a><br /></dt>
<dd><p>Describes exceptions originating from the DVC library. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms13dvc_exception13dvc_exceptionERRNSt6stringE">
<span id="_CPPv3N7dolbyio5comms13dvc_exception13dvc_exceptionERRNSt6stringE"></span><span id="_CPPv2N7dolbyio5comms13dvc_exception13dvc_exceptionERRNSt6stringE"></span><span id="dolbyio::comms::dvc_exception::dvc_exception__ssRR"></span><span class="target" id="classdolbyio_1_1comms_1_1dvc__exception_1a88464518335a5f57c143c3985c931640"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">dvc_exception</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">description</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N7dolbyio5comms13dvc_exception13dvc_exceptionERRNSt6stringE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The constructor that takes a description of the exception. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>description</strong> – The description of the exception. </p>
</dd>
</dl>
</dd></dl>
</div>
</dd></dl>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms21certificate_exceptionE">
<span id="_CPPv3N7dolbyio5comms21certificate_exceptionE"></span><span id="_CPPv2N7dolbyio5comms21certificate_exceptionE"></span><span id="dolbyio::comms::certificate_exception"></span><span class="target" id="classdolbyio_1_1comms_1_1certificate__exception"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">certificate_exception</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">dolbyio</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">comms</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N7dolbyio5comms9exceptionE" title="dolbyio::comms::exception"><span class="n"><span class="pre">exception</span></span></a><a class="headerlink" href="#_CPPv4N7dolbyio5comms21certificate_exceptionE" title="Permalink to this definition"></a><br /></dt>
<dd><p>Describes the exception thrown if WebRTC fails to generate a certificate. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms21certificate_exception21certificate_exceptionERRNSt6stringE">
<span id="_CPPv3N7dolbyio5comms21certificate_exception21certificate_exceptionERRNSt6stringE"></span><span id="_CPPv2N7dolbyio5comms21certificate_exception21certificate_exceptionERRNSt6stringE"></span><span id="dolbyio::comms::certificate_exception::certificate_exception__ssRR"></span><span class="target" id="classdolbyio_1_1comms_1_1certificate__exception_1ad4b7bad6cf9c619c462c8dea07a1cf1c"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">certificate_exception</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">description</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N7dolbyio5comms21certificate_exception21certificate_exceptionERRNSt6stringE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The constructor that takes a description of the exception. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>description</strong> – The description of the exception. </p>
</dd>
</dl>
</dd></dl>
</div>
</dd></dl>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms24security_check_exceptionE">
<span id="_CPPv3N7dolbyio5comms24security_check_exceptionE"></span><span id="_CPPv2N7dolbyio5comms24security_check_exceptionE"></span><span id="dolbyio::comms::security_check_exception"></span><span class="target" id="classdolbyio_1_1comms_1_1security__check__exception"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">security_check_exception</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">dolbyio</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">comms</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N7dolbyio5comms12io_exceptionE" title="dolbyio::comms::io_exception"><span class="n"><span class="pre">io_exception</span></span></a><a class="headerlink" href="#_CPPv4N7dolbyio5comms24security_check_exceptionE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The class for exceptions indicating that the CA certificates are not properly loaded. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms24security_check_exception24security_check_exceptionERKNSt6stringE">
<span id="_CPPv3N7dolbyio5comms24security_check_exception24security_check_exceptionERKNSt6stringE"></span><span id="_CPPv2N7dolbyio5comms24security_check_exception24security_check_exceptionERKNSt6stringE"></span><span id="dolbyio::comms::security_check_exception::security_check_exception__ssCR"></span><span class="target" id="classdolbyio_1_1comms_1_1security__check__exception_1a7694d4fbce7ef491e8169b0690f2004b"></span><span class="sig-name descname"><span class="n"><span class="pre">security_check_exception</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">message</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N7dolbyio5comms24security_check_exception24security_check_exceptionERKNSt6stringE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The <a class="reference internal" href="#classdolbyio_1_1comms_1_1security__check__exception"><span class="std std-ref">security_check_exception</span></a> constructor. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>message</strong> – A string that describes the error. </p>
</dd>
</dl>
</dd></dl>
</div>
</dd></dl>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms27signaling_channel_exceptionE">
<span id="_CPPv3N7dolbyio5comms27signaling_channel_exceptionE"></span><span id="_CPPv2N7dolbyio5comms27signaling_channel_exceptionE"></span><span id="dolbyio::comms::signaling_channel_exception"></span><span class="target" id="classdolbyio_1_1comms_1_1signaling__channel__exception"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">signaling_channel_exception</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">dolbyio</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">comms</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N7dolbyio5comms12io_exceptionE" title="dolbyio::comms::io_exception"><span class="n"><span class="pre">io_exception</span></span></a><a class="headerlink" href="#_CPPv4N7dolbyio5comms27signaling_channel_exceptionE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The class that describes IO errors that occur on the signaling WebSocket. The user can also set a listener for this exception object using <a class="reference internal" href="../sdk.html#classdolbyio_1_1comms_1_1sdk_1abee8e8b0d070c11d0053da99e21a464b"><span class="std std-ref">sdk::add_event_handler</span></a> to emitted the event whenever a signaling error occurs. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms27signaling_channel_exception27signaling_channel_exceptionERKNSt6stringE">
<span id="_CPPv3N7dolbyio5comms27signaling_channel_exception27signaling_channel_exceptionERKNSt6stringE"></span><span id="_CPPv2N7dolbyio5comms27signaling_channel_exception27signaling_channel_exceptionERKNSt6stringE"></span><span id="dolbyio::comms::signaling_channel_exception::signaling_channel_exception__ssCR"></span><span class="target" id="classdolbyio_1_1comms_1_1signaling__channel__exception_1a0a89b65302b50befa79b4b30f5830dfa"></span><span class="sig-name descname"><span class="n"><span class="pre">signaling_channel_exception</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">message</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N7dolbyio5comms27signaling_channel_exception27signaling_channel_exceptionERKNSt6stringE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The <a class="reference internal" href="#classdolbyio_1_1comms_1_1signaling__channel__exception"><span class="std std-ref">signaling_channel_exception</span></a> constructor. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>message</strong> – A string that describes the error. </p>
</dd>
</dl>
</dd></dl>
</div>
</dd></dl>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms23invalid_token_exceptionE">
<span id="_CPPv3N7dolbyio5comms23invalid_token_exceptionE"></span><span id="_CPPv2N7dolbyio5comms23invalid_token_exceptionE"></span><span id="dolbyio::comms::invalid_token_exception"></span><span class="target" id="classdolbyio_1_1comms_1_1invalid__token__exception"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">invalid_token_exception</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">dolbyio</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">comms</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N7dolbyio5comms17restapi_exceptionE" title="dolbyio::comms::restapi_exception"><span class="n"><span class="pre">restapi_exception</span></span></a><a class="headerlink" href="#_CPPv4N7dolbyio5comms23invalid_token_exceptionE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The class that describes the rejected REST API requests caused by an invalid access token. The user can also set a listener for this exception object using <a class="reference internal" href="../sdk.html#classdolbyio_1_1comms_1_1sdk_1abee8e8b0d070c11d0053da99e21a464b"><span class="std std-ref">sdk::add_event_handler</span></a>. In such a case, the event will be emitted whenever a signaling error occurs. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N7dolbyio5comms23invalid_token_exception23invalid_token_exceptionEiiRKNSt6stringERKNSt6stringE">
<span id="_CPPv3N7dolbyio5comms23invalid_token_exception23invalid_token_exceptionEiiRKNSt6stringERKNSt6stringE"></span><span id="_CPPv2N7dolbyio5comms23invalid_token_exception23invalid_token_exceptionEiiRKNSt6stringERKNSt6stringE"></span><span id="dolbyio::comms::invalid_token_exception::invalid_token_exception__i.i.ssCR.ssCR"></span><span class="target" id="classdolbyio_1_1comms_1_1invalid__token__exception_1a4b0561298e7f945a22751678511ad0e9"></span><span class="sig-name descname"><span class="n"><span class="pre">invalid_token_exception</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">http_code</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">rest_code</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">err_reason</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">err_description</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N7dolbyio5comms23invalid_token_exception23invalid_token_exceptionEiiRKNSt6stringERKNSt6stringE" title="Permalink to this definition"></a><br /></dt>
<dd><p>The constructor that takes the error codes, reasons, and descriptions of the error that is in the server response. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>http_code</strong> – The HTTP code. </p></li>
<li><p><strong>rest_code</strong> – The REST API code. </p></li>
<li><p><strong>err_reason</strong> – The reason for the error. </p></li>
<li><p><strong>err_description</strong> – The error description. </p></li>
</ul>
</dd>
</dl>
</dd></dl>
</div>
</dd></dl>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="log_level.html" class="btn btn-neutral float-left" title="Logging" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="event_handling.html" class="btn btn-neutral float-right" title="Event Handling Interface" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright Dolby Laboratories.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>