Hyak.Common.xml
|
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 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 |
<?xml version="1.0"?>
<doc> <assembly> <name>Hyak.Common</name> </assembly> <members> <member name="T:Hyak.Common.CloudCredentials"> <summary> The CloudCredentials class is the base class for providing credentials to access REST services. </summary> </member> <member name="M:Hyak.Common.CloudCredentials.InitializeServiceClient``1(Hyak.Common.ServiceClient{``0})"> <summary> Initialize a ServiceClient instance to process credentials. </summary> <typeparam name="T">Type of ServiceClient.</typeparam> <param name="client">The ServiceClient.</param> </member> <member name="M:Hyak.Common.CloudCredentials.ProcessHttpRequestAsync(System.Net.Http.HttpRequestMessage,System.Threading.CancellationToken)"> <summary> Apply the credentials to the HTTP request. </summary> <param name="request">The HTTP request.</param> <param name="cancellationToken">Cancellation token.</param> <returns> Task that will complete when processing has completed. </returns> </member> <member name="T:Hyak.Common.CloudError"> <summary> Representation of the error object from the server. </summary> </member> <member name="P:Hyak.Common.CloudError.Message"> <summary> Parsed error message. </summary> </member> <member name="P:Hyak.Common.CloudError.Code"> <summary> Parsed error code. </summary> </member> <member name="P:Hyak.Common.CloudError.OriginalMessage"> <summary> Original error body </summary> </member> <member name="P:Hyak.Common.CloudError.ResponseBody"> <summary> Original response message body </summary> </member> <member name="T:Hyak.Common.CloudHttpErrorInfo"> <summary> Base class used to describe HTTP requests and responses associated with error conditions. </summary> </member> <member name="M:Hyak.Common.CloudHttpErrorInfo.#ctor"> <summary> Initializes a new instance of the CloudHttpErrorInfo class. </summary> </member> <member name="M:Hyak.Common.CloudHttpErrorInfo.CopyHeaders(System.Net.Http.Headers.HttpHeaders)"> <summary> Add the HTTP message headers to the error info. </summary> <param name="headers">Collection of HTTP header.</param> </member> <member name="P:Hyak.Common.CloudHttpErrorInfo.Content"> <summary> Gets or sets the contents of the HTTP message. </summary> </member> <member name="P:Hyak.Common.CloudHttpErrorInfo.Headers"> <summary> Gets the collection of HTTP headers. </summary> </member> <member name="P:Hyak.Common.CloudHttpErrorInfo.Version"> <summary> Gets or sets the HTTP message version. </summary> </member> <member name="T:Hyak.Common.CloudHttpRequestErrorInfo"> <summary> Describes HTTP requests associated with error conditions. </summary> </member> <member name="M:Hyak.Common.CloudHttpRequestErrorInfo.#ctor"> <summary> Initializes a new instance of the CloudHttpRequestErrorInfo class. </summary> </member> <member name="M:Hyak.Common.CloudHttpRequestErrorInfo.Create(System.Net.Http.HttpRequestMessage)"> <summary> Creates a new CloudHttpRequestErrorInfo from a HttpRequestMessage. </summary> <param name="request">The request message.</param> <returns>A CloudHttpRequestErrorInfo instance.</returns> </member> <member name="M:Hyak.Common.CloudHttpRequestErrorInfo.Create(System.Net.Http.HttpRequestMessage,System.String)"> <summary> Creates a new CloudHttpRequestErrorInfo from a HttpRequestMessage. </summary> <param name="request">The request message.</param> <param name="content"> The request content, which may be passed separately if the request has already been disposed. </param> <returns>A CloudHttpRequestErrorInfo instance.</returns> </member> <member name="P:Hyak.Common.CloudHttpRequestErrorInfo.Method"> <summary> Gets or sets the HTTP method used by the HTTP request message. </summary> </member> <member name="P:Hyak.Common.CloudHttpRequestErrorInfo.RequestUri"> <summary> Gets or sets the Uri used for the HTTP request. </summary> </member> <member name="P:Hyak.Common.CloudHttpRequestErrorInfo.Properties"> <summary> Gets a set of properties for the HTTP request. </summary> </member> <member name="T:Hyak.Common.CloudHttpResponseErrorInfo"> <summary> Describes HTTP responses associated with error conditions. </summary> </member> <member name="M:Hyak.Common.CloudHttpResponseErrorInfo.#ctor"> <summary> Initializes a new instance of the CloudHttpResponseErrorInfo class. </summary> </member> <member name="M:Hyak.Common.CloudHttpResponseErrorInfo.Create(System.Net.Http.HttpResponseMessage)"> <summary> Creates a new CloudHttpResponseErrorInfo from a HttpResponseMessage. </summary> <param name="response">The response message.</param> <returns>A CloudHttpResponseErrorInfo instance.</returns> </member> <member name="M:Hyak.Common.CloudHttpResponseErrorInfo.Create(System.Net.Http.HttpResponseMessage,System.String)"> <summary> Creates a new CloudHttpResponseErrorInfo from a HttpResponseMessage. </summary> <param name="response">The response message.</param> <param name="content"> The response content, which may be passed separately if the response has already been disposed. </param> <returns>A CloudHttpResponseErrorInfo instance.</returns> </member> <member name="P:Hyak.Common.CloudHttpResponseErrorInfo.StatusCode"> <summary> Gets or sets the status code of the HTTP response. </summary> </member> <member name="P:Hyak.Common.CloudHttpResponseErrorInfo.ReasonPhrase"> <summary> Gets or sets the reason phrase which typically is sent by servers together with the status code. </summary> </member> <member name="T:Hyak.Common.Internals.DisposableReference`1"> <summary> Wrapper class that provides manual reference count functionality </summary> <typeparam name="T">Type to wrap around. Must be disposable.</typeparam> </member> <member name="T:Hyak.Common.Internals.HttpExtensions"> <summary> Extensions for manipulating HTTP requests and responses. </summary> </member> <member name="M:Hyak.Common.Internals.HttpExtensions.AsString(System.Net.Http.HttpContent)"> <summary> Get the HTTP message content as a string. </summary> <param name="content">The HTTP content.</param> <returns>The HTTP message content as a string.</returns> </member> <member name="M:Hyak.Common.Internals.HttpExtensions.GetContentHeaders(System.Net.Http.HttpRequestMessage)"> <summary> Get the content headers for an HTTP request. </summary> <param name="request">The request message.</param> <returns>The content headers.</returns> </member> <member name="M:Hyak.Common.Internals.HttpExtensions.GetContentHeaders(System.Net.Http.HttpResponseMessage)"> <summary> Get the content headers for an HTTP response. </summary> <param name="response">The response message.</param> <returns>The content headers.</returns> </member> <member name="M:Hyak.Common.Internals.HttpExtensions.AsString(System.Net.Http.HttpRequestMessage)"> <summary> Get a standard string representation of an HTTP request. </summary> <param name="request">The request message.</param> <returns>String representation of the request.</returns> </member> <member name="M:Hyak.Common.Internals.HttpExtensions.AsString(Hyak.Common.CloudHttpRequestErrorInfo)"> <summary> Get a standard string representation of an HTTP request. </summary> <param name="request">The request message.</param> <returns>String representation of the request.</returns> </member> <member name="M:Hyak.Common.Internals.HttpExtensions.AppendHttpRequest(System.Text.StringBuilder,System.Net.Http.HttpRequestMessage)"> <summary> Append an HTTP request. </summary> <param name="text">The StringBuilder.</param> <param name="request">The request message.</param> </member> <member name="M:Hyak.Common.Internals.HttpExtensions.AppendHttpRequest(System.Text.StringBuilder,Hyak.Common.CloudHttpRequestErrorInfo)"> <summary> Append an HTTP request. </summary> <param name="text">The StringBuilder.</param> <param name="request">The request message.</param> </member> <member name="M:Hyak.Common.Internals.HttpExtensions.AppendHttpRequest(System.Text.StringBuilder,System.Net.Http.HttpMethod,System.Uri,System.Version,System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.Collections.Generic.IEnumerable{System.String}}},System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.Collections.Generic.IEnumerable{System.String}}},System.Collections.Generic.IDictionary{System.String,System.Object},System.String)"> <summary> Append the components of an HTTP request. </summary> <param name="text">The StringBuilder.</param> <param name="method">The request method.</param> <param name="requestUri">The request URI.</param> <param name="version">The request HTTP version.</param> <param name="headers">The request headers.</param> <param name="contentHeaders">The request content headers.</param> <param name="properties">The request properties.</param> <param name="content">The request content.</param> </member> <member name="M:Hyak.Common.Internals.HttpExtensions.AsString(System.Net.Http.HttpResponseMessage)"> <summary> Get a standard string representation of an HTTP response. </summary> <param name="response">The response message.</param> <returns>String representation of the response.</returns> </member> <member name="M:Hyak.Common.Internals.HttpExtensions.AsString(Hyak.Common.CloudHttpResponseErrorInfo)"> <summary> Get a standard string representation of an HTTP response. </summary> <param name="response">The response message.</param> <returns>String representation of the response.</returns> </member> <member name="M:Hyak.Common.Internals.HttpExtensions.AppendHttpResponse(System.Text.StringBuilder,System.Net.Http.HttpResponseMessage)"> <summary> Append an HTTP response. </summary> <param name="text">The StringBuilder.</param> <param name="response">The response message.</param> </member> <member name="M:Hyak.Common.Internals.HttpExtensions.AppendHttpResponse(System.Text.StringBuilder,Hyak.Common.CloudHttpResponseErrorInfo)"> <summary> Append an HTTP response. </summary> <param name="text">The StringBuilder.</param> <param name="response">The response message.</param> </member> <member name="M:Hyak.Common.Internals.HttpExtensions.AppendHttpResponse(System.Text.StringBuilder,System.Net.HttpStatusCode,System.String,System.Version,System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.Collections.Generic.IEnumerable{System.String}}},System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.Collections.Generic.IEnumerable{System.String}}},System.String)"> <summary> Append the components of an HTTP response. </summary> <param name="text">The StringBuilder.</param> <param name="statusCode">The response status code.</param> <param name="reasonPhrase">The response reason phrase.</param> <param name="version">The response HTTP version.</param> <param name="headers">The response headers.</param> <param name="contentHeaders">The response content headers.</param> <param name="content">The response content.</param> </member> <member name="M:Hyak.Common.Internals.HttpExtensions.AppendHttpHeaders(System.Text.StringBuilder,System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.Collections.Generic.IEnumerable{System.String}}})"> <summary> Append HTTP headers. </summary> <param name="text">The StringBuilder.</param> <param name="headers">The HTTP headers.</param> </member> <member name="T:Hyak.Common.Internals.IndisposableDelegatingHandler"> <summary> Wrapper class for HttpMessageHandler that prevents InnerHandler from being disposed. </summary> </member> <member name="M:Hyak.Common.Internals.IndisposableDelegatingHandler.#ctor(System.Net.Http.HttpMessageHandler)"> <summary> Initializes a new instance of the <see cref="T:Hyak.Common.Internals.IndisposableDelegatingHandler"/> class from HttpMessageHandler. </summary> <param name="innerHandler">InnerHandler to wrap.</param> </member> <member name="M:Hyak.Common.Internals.IndisposableDelegatingHandler.Dispose(System.Boolean)"> <summary> Overrides Dispose of the base class to prevent disposal of the InnerHandler. </summary> <param name="disposing">If set to true indicates the method is being called from Dispose().</param> </member> <member name="T:Hyak.Common.Internals.TypeConversion"> <summary> Static type conversion utility methods. </summary> </member> <member name="M:Hyak.Common.Internals.TypeConversion.ToBase64String(System.String)"> <summary> Converts an array of 8-bit unsigned integers to its equivalent string representation that is encoded with base-64 digits. </summary> <param name="value">An array of 8-bit unsigned integers.</param> <returns>The string representation, in base 64, of the contents of value.</returns> </member> <member name="M:Hyak.Common.Internals.TypeConversion.BytesToString(System.Byte[])"> <summary> Decodes all the bytes in the specified byte array into a string. </summary> <param name="value">The byte array containing the sequence of bytes to decode.</param> <returns>A string that contains the results of decoding the specified sequence of bytes.</returns> </member> <member name="M:Hyak.Common.Internals.TypeConversion.FromBase64String(System.String)"> <summary> Converts the specified string, which encodes binary data as base-64 digits, to a UTF8-encoded string. </summary> <param name="value">The base 64-encoded string to convert.</param> <returns>Returns a string.</returns> </member> <member name="M:Hyak.Common.Internals.TypeConversion.TryParseUri(System.String)"> <summary> Uses Uri::TryCreate method to safely attempt to parse a string value and return its Uri representation. Supports relative Uris. </summary> <param name="value">The Uri string.</param> <returns>Returns a new Uri instance or null.</returns> </member> <member name="T:Hyak.Common.HttpOperationResponse"> <summary> A standard service response including an HTTP status code and request ID. </summary> </member> <member name="P:Hyak.Common.HttpOperationResponse.StatusCode"> <summary> Gets or sets the standard HTTP status code from the REST API operations for the Service Management API. </summary> </member> <member name="T:Hyak.Common.RetryHandler"> <summary> Http retry handler. </summary> </member> <member name="M:Hyak.Common.RetryHandler.#ctor"> <summary> Initializes a new instance of the <see cref="T:Hyak.Common.RetryHandler"/> class. Sets default retry policty base on Exponential Backoff. </summary> </member> <member name="M:Hyak.Common.RetryHandler.#ctor(System.Net.Http.DelegatingHandler)"> <summary> Initializes a new instance of the <see cref="T:Hyak.Common.RetryHandler"/> class. Sets the default retry policty base on Exponential Backoff. </summary> <param name="innerHandler">Inner http handler.</param> </member> <member name="M:Hyak.Common.RetryHandler.#ctor(Hyak.Common.TransientFaultHandling.RetryPolicy,System.Net.Http.DelegatingHandler)"> <summary> Initializes a new instance of the <see cref="T:Hyak.Common.RetryHandler"/> class. </summary> <param name="retryPolicy">Retry policy to use.</param> <param name="innerHandler">Inner http handler.</param> </member> <member name="M:Hyak.Common.RetryHandler.SendAsync(System.Net.Http.HttpRequestMessage,System.Threading.CancellationToken)"> <summary> Sends an HTTP request to the inner handler to send to the server as an asynchronous operation. Retries request if needed based on Retry Policy. </summary> <param name="request">The HTTP request message to send to the server.</param> <param name="cancellationToken">A cancellation token to cancel operation.</param> <returns>Returns System.Threading.Tasks.Task<TResult>. The task object representing the asynchronous operation.</returns> </member> <member name="P:Hyak.Common.RetryHandler.RetryPolicy"> <summary> Gets or sets retry policy. </summary> </member> <member name="E:Hyak.Common.RetryHandler.Retrying"> <summary> An instance of a callback delegate that will be invoked whenever a retry condition is encountered. </summary> </member> <member name="F:Hyak.Common.TracingAdapter._interceptors"> <summary> The collection of tracing interceptors to notify. </summary> </member> <member name="F:Hyak.Common.TracingAdapter._threadSafeInterceptors"> <summary> A read-only, thread-safe collection of tracing interceptors. Since List is only thread-safe for reads (and adding/removing tracing interceptors isn't a very common operation), we simply replace the entire collection of interceptors so any enumeration of the list in progress on a different thread will not be affected by the change. </summary> </member> <member name="F:Hyak.Common.TracingAdapter._lock"> <summary> Lock used to synchronize mutation of the tracing interceptors. </summary> </member> <member name="M:Hyak.Common.TracingAdapter.#cctor"> <summary> Initializes a new instance of the CloudTracing class. </summary> </member> <member name="M:Hyak.Common.TracingAdapter.AddTracingInterceptor(Hyak.Common.ICloudTracingInterceptor)"> <summary> Add a tracing interceptor to be notified of changes. </summary> <param name="interceptor">The tracing interceptor.</param> </member> <member name="M:Hyak.Common.TracingAdapter.RemoveTracingInterceptor(Hyak.Common.ICloudTracingInterceptor)"> <summary> Remove a tracing interceptor from change notifications. </summary> <param name="interceptor">The tracing interceptor.</param> <returns> True if the tracing interceptor was found and removed; false otherwise. </returns> </member> <member name="P:Hyak.Common.TracingAdapter.IsEnabled"> <summary> Gets or sets a value indicating whether tracing is enabled. Tracing can be disabled for performance. </summary> </member> <member name="P:Hyak.Common.TracingAdapter.TracingInterceptors"> <summary> Gets a sequence of the tracing interceptors to notify of changes. </summary> </member> <member name="T:Hyak.Common.ServiceClient`1"> <summary> The base ServiceClient class used to call REST services. </summary> <typeparam name="T">Type of the ServiceClient.</typeparam> </member> <member name="F:Hyak.Common.ServiceClient`1._transportHandlerProvider"> <summary> Gets the Platform's IHttpTransportHandlerProvider which gives the default HttpHandler for sending web requests. </summary> </member> <member name="F:Hyak.Common.ServiceClient`1._disposed"> <summary> A value indicating whether or not the ServiceClient has already been disposed. </summary> </member> <member name="F:Hyak.Common.ServiceClient`1._innerHandler"> <summary> Reference to the delegated handler of our handler (so we can maintain a proper reference count). </summary> </member> <member name="F:Hyak.Common.ServiceClient`1._handler"> <summary> Reference to our HTTP handler (which is the start of our HTTP pipeline). </summary> </member> <member name="M:Hyak.Common.ServiceClient`1.#cctor"> <summary> Initializes static members of the ServiceClient class. </summary> </member> <member name="M:Hyak.Common.ServiceClient`1.#ctor"> <summary> Initializes a new instance of the ServiceClient class. </summary> </member> <member name="M:Hyak.Common.ServiceClient`1.#ctor(System.Net.Http.HttpClient)"> <summary> Initializes a new instance of the ServiceClient class. </summary> <param name="httpClient">The http client.</param> </member> <member name="M:Hyak.Common.ServiceClient`1.Dispose"> <summary> Dispose the ServiceClient. </summary> </member> <member name="M:Hyak.Common.ServiceClient`1.GetHttpPipeline"> <summary> Get the HTTP pipeline for the given service client. </summary> <returns>The client's HTTP pipeline.</returns> </member> <member name="M:Hyak.Common.ServiceClient`1.AddHandlerToPipeline(System.Net.Http.DelegatingHandler)"> <summary> Add a handler to the end of the client's HTTP pipeline. </summary> <param name="handler">The handler to add.</param> </member> <member name="M:Hyak.Common.ServiceClient`1.SetRetryPolicy(Hyak.Common.TransientFaultHandling.RetryPolicy)"> <summary> Sets retry policy for the client. </summary> <param name="retryPolicy">Retry policy to set.</param> </member> <member name="M:Hyak.Common.ServiceClient`1.InitializeHttpClient(System.Net.Http.HttpMessageHandler)"> <summary> Initializes HttpClient. </summary> <param name="httpMessageHandler">Http message handler to use with Http client.</param> </member> <member name="M:Hyak.Common.ServiceClient`1.CreateHttpClient"> <summary> Create the HTTP client. </summary> <returns>The HTTP client.</returns> </member> <member name="M:Hyak.Common.ServiceClient`1.GetAssemblyVersion"> <summary> Get the assembly version of a service client. </summary> <returns>The assembly version of the client.</returns> </member> <member name="M:Hyak.Common.ServiceClient`1.Clone(Hyak.Common.ServiceClient{`0})"> <summary> Clone the service client. </summary> <param name="client">The client to clone.</param> </member> <member name="M:Hyak.Common.ServiceClient`1.CloneHttpClient(System.Net.Http.HttpClient,System.Net.Http.HttpClient)"> <summary> Clone HttpClient properties. </summary> <param name="source">The client to clone.</param> <param name="destination">The client to copy into.</param> </member> <member name="M:Hyak.Common.ServiceClient`1.WithHandler(Hyak.Common.ServiceClient{`0},System.Net.Http.DelegatingHandler)"> <summary> Extend the ServiceClient with a new handler. </summary> <param name="newClient">The new client that will extend.</param> <param name="handler">The handler to extend with.</param> <returns>The extended client.</returns> </member> <member name="P:Hyak.Common.ServiceClient`1.HttpClient"> <summary> Gets the HttpClient used for making HTTP requests. </summary> </member> <member name="P:Hyak.Common.ServiceClient`1.HttpMessageHandler"> <summary> Gets a reference to our HTTP handler (which is the start of our HTTP pipeline). </summary> </member> <member name="P:Hyak.Common.ServiceClient`1.UserAgent"> <summary> Gets the UserAgent collection which can be augmented with custom user agent strings. </summary> </member> <member name="T:Hyak.Common.IServiceOperations`1"> <summary> Interface used to represent resource groupings of ServiceClient operations. </summary> <typeparam name="TClient">Type of the ServiceClient.</typeparam> </member> <member name="P:Hyak.Common.IServiceOperations`1.Client"> <summary> Gets a reference to the ServiceClient. </summary> </member> <member name="T:Hyak.Common.CloudException"> <summary> Exception thrown for any invalid response. </summary> </member> <member name="M:Hyak.Common.CloudException.#ctor(System.String)"> <summary> Initializes a new instance of the CloudException class. </summary> <param name="message">The exception message.</param> </member> <member name="M:Hyak.Common.CloudException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the CloudException class. </summary> <param name="message">The exception message.</param> <param name="innerException">Inner exception.</param> </member> <member name="M:Hyak.Common.CloudException.Create(System.Net.Http.HttpRequestMessage,System.String,System.Net.Http.HttpResponseMessage,System.String,System.Exception)"> <summary> Create a CloudException from a failed response. </summary> <param name="request">The HTTP request.</param> <param name="requestContent">The HTTP request content.</param> <param name="response">The HTTP response.</param> <param name="responseContent">The HTTP response content.</param> <param name="innerException">Optional inner exception.</param> <returns>A CloudException representing the failure.</returns> </member> <member name="M:Hyak.Common.CloudException.Create(System.Net.Http.HttpRequestMessage,System.String,System.Net.Http.HttpResponseMessage,System.String,Hyak.Common.CloudExceptionType,System.Exception)"> <summary> Create a CloudException from a failed response. This method is obsolete. Use Create without defaultTo parameter. </summary> <param name="request">The HTTP request.</param> <param name="requestContent">The HTTP request content.</param> <param name="response">The HTTP response.</param> <param name="responseContent">The HTTP response content.</param> <param name="defaultTo">The content type to default to if none of the types matches.</param> <param name="innerException">Optional inner exception.</param> <returns>A CloudException representing the failure.</returns> </member> <member name="M:Hyak.Common.CloudException.CreateFromXml(System.Net.Http.HttpRequestMessage,System.String,System.Net.Http.HttpResponseMessage,System.String,System.Exception)"> <summary> Create a CloudException from a failed response sending XML content. This method is obsolete. Use Create without defaultTo parameter. </summary> <param name="request">The HTTP request.</param> <param name="requestContent">The HTTP request content.</param> <param name="response">The HTTP response.</param> <param name="responseContent">The HTTP response content.</param> <param name="innerException">Optional inner exception.</param> <returns>A CloudException representing the failure.</returns> </member> <member name="M:Hyak.Common.CloudException.CreateFromJson(System.Net.Http.HttpRequestMessage,System.String,System.Net.Http.HttpResponseMessage,System.String,System.Exception)"> <summary> Create a CloudException from a failed response sending JSON content. This method is obsolete. Use Create without defaultTo parameter. </summary> <param name="request">The HTTP request.</param> <param name="requestContent">The HTTP request content.</param> <param name="response">The HTTP response.</param> <param name="responseContent">The HTTP response content.</param> <param name="innerException">Optional inner exception.</param> <returns>A CloudException representing the failure.</returns> </member> <member name="M:Hyak.Common.CloudException.ParseXmlOrJsonError(System.String)"> <summary> Parse the response content as either an XML or JSON error message. </summary> <param name="content">The response content.</param> <returns> An object containing the parsed error code and message. </returns> </member> <member name="M:Hyak.Common.CloudException.ParseXmlError(System.String)"> <summary> Parse the response content as an XML error message. </summary> <param name="content">The response content.</param> <returns> An object containing the parsed error code and message. </returns> </member> <member name="M:Hyak.Common.CloudException.ParseJsonError(System.String)"> <summary> Parse the response content as an JSON error message. </summary> <param name="content">The response content.</param> <returns> An object containing the parsed error code and message. </returns> </member> <member name="M:Hyak.Common.CloudException.IsXml(System.String,System.Boolean)"> <summary> Checks if content is possibly an XML. </summary> <param name="content">String to check.</param> <param name="validate">If set to true will validate entire XML for validity otherwise will just check the first character.</param> <returns>True is content is possibly an XML otherwise false.</returns> </member> <member name="M:Hyak.Common.CloudException.IsJson(System.String,System.Boolean)"> <summary> Checks if content is possibly a JSON. </summary> <param name="content">String to check.</param> <param name="validate">If set to true will validate entire JSON for validity otherwise will just check the first character.</param> <returns>True is content is possibly an JSON otherwise false.</returns> </member> <member name="M:Hyak.Common.CloudException.FirstNonWhitespaceCharacter(System.String)"> <summary> Returns first non whitespace character </summary> <param name="content">Text to search in</param> <returns>Non whitespace or default char</returns> </member> <member name="P:Hyak.Common.CloudException.Error"> <summary> Gets the error returned from the server. </summary> </member> <member name="P:Hyak.Common.CloudException.Request"> <summary> Gets information about the associated HTTP request. </summary> </member> <member name="P:Hyak.Common.CloudException.Response"> <summary> Gets information about the associated HTTP response. </summary> </member> <member name="T:Hyak.Common.TracingExtensions"> <summary> Helper extension methods used by tracing providers. </summary> </member> <member name="M:Hyak.Common.TracingExtensions.AsFormattedString(System.Net.Http.HttpRequestMessage)"> <summary> Returns string representation of a HttpRequestMessage. </summary> <param name="httpRequest">Request to format.</param> <returns>Formatted string.</returns> </member> <member name="M:Hyak.Common.TracingExtensions.AsFormattedString(System.Net.Http.HttpResponseMessage)"> <summary> Returns string representation of a HttpResponseMessage. </summary> <param name="httpResponse">Response to format.</param> <returns>Formatted string.</returns> </member> <member name="M:Hyak.Common.TracingExtensions.AsFormattedString``2(System.Collections.Generic.IDictionary{``0,``1})"> <summary> Converts given dictionary into a log string. </summary> <typeparam name="TKey">The dictionary key type</typeparam> <typeparam name="TValue">The dictionary value type</typeparam> <param name="dictionary">The dictionary collection object</param> <returns>The log string</returns> </member> <member name="T:Hyak.Common.ICloudTracingInterceptor"> <summary> The ICloudTracingInterceptor provides useful information about cloud operations. Interception is global and a tracing interceptor can be added via TracingAdapter.AddTracingInterceptor. </summary> </member> <member name="M:Hyak.Common.ICloudTracingInterceptor.Information(System.String)"> <summary> Trace information. </summary> <param name="message">The information to trace.</param> </member> <member name="M:Hyak.Common.ICloudTracingInterceptor.Configuration(System.String,System.String,System.String)"> <summary> Probe configuration for the value of a setting. </summary> <param name="source">The configuration source.</param> <param name="name">The name of the setting.</param> <param name="value">The value of the setting in the source.</param> </member> <member name="M:Hyak.Common.ICloudTracingInterceptor.Enter(System.String,System.Object,System.String,System.Collections.Generic.IDictionary{System.String,System.Object})"> <summary> Enter a method. </summary> <param name="invocationId">Method invocation identifier.</param> <param name="instance">The instance with the method.</param> <param name="method">Name of the method.</param> <param name="parameters">Method parameters.</param> </member> <member name="M:Hyak.Common.ICloudTracingInterceptor.SendRequest(System.String,System.Net.Http.HttpRequestMessage)"> <summary> Send an HTTP request. </summary> <param name="invocationId">Method invocation identifier.</param> <param name="request">The request about to be sent.</param> </member> <member name="M:Hyak.Common.ICloudTracingInterceptor.ReceiveResponse(System.String,System.Net.Http.HttpResponseMessage)"> <summary> Receive an HTTP response. </summary> <param name="invocationId">Method invocation identifier.</param> <param name="response">The response instance.</param> </member> <member name="M:Hyak.Common.ICloudTracingInterceptor.Error(System.String,System.Exception)"> <summary> Raise an error. </summary> <param name="invocationId">Method invocation identifier.</param> <param name="exception">The error.</param> </member> <member name="M:Hyak.Common.ICloudTracingInterceptor.Exit(System.String,System.Object)"> <summary> Exit a method. Note: Exit will not be called in the event of an error. </summary> <param name="invocationId">Method invocation identifier.</param> <param name="returnValue">Method return value.</param> </member> <member name="T:Hyak.Common.Properties.Resources"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:Hyak.Common.Properties.Resources.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:Hyak.Common.Properties.Resources.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:Hyak.Common.Properties.Resources.ArgumentCannotBeEmpty"> <summary> Looks up a localized string similar to Value cannot be empty. Parameter name: {0}. </summary> </member> <member name="P:Hyak.Common.Properties.Resources.ArgumentCannotBeGreaterThanBaseline"> <summary> Looks up a localized string similar to The specified argument {0} cannot be greater than its ceiling value of {1}.. </summary> </member> <member name="P:Hyak.Common.Properties.Resources.ArgumentCannotBeNegative"> <summary> Looks up a localized string similar to The specified argument {0} cannot be initialized with a negative value.. </summary> </member> <member name="P:Hyak.Common.Properties.Resources.ConfigurationHelper_CreateCouldNotConvertException"> <summary> Looks up a localized string similar to Failed to convert parameter {0} value '{1}' to type {2}.. </summary> </member> <member name="P:Hyak.Common.Properties.Resources.ConfigurationHelper_CreateFromSettings_CreateSettingsFailedException"> <summary> Looks up a localized string similar to {3} Failed to create {0} from connection settings {1} = "{2}".. </summary> </member> <member name="P:Hyak.Common.Properties.Resources.ConfigurationHelper_CreateFromSettings_NoConnectionSettingsFound"> <summary> Looks up a localized string similar to No connection settings found for type {0}. Enable tracing for more information.. </summary> </member> <member name="P:Hyak.Common.Properties.Resources.ConfigurationHelper_GetCredentials_NotFound"> <summary> Looks up a localized string similar to No credentials of type '{0}' could be initialized from the provided settings.. </summary> </member> <member name="P:Hyak.Common.Properties.Resources.ConfigurationHelper_GetParameter_NotFound"> <summary> Looks up a localized string similar to Parameter {0} is required.. </summary> </member> <member name="P:Hyak.Common.Properties.Resources.DefaultRetryStrategyMappingNotFound"> <summary> Looks up a localized string similar to Default retry strategy for technology {0}, named '{1}', is not defined.. </summary> </member> <member name="P:Hyak.Common.Properties.Resources.DefaultRetryStrategyNotFound"> <summary> Looks up a localized string similar to Default retry strategy for technology {0} was not not defined, and there is no overall default strategy.. </summary> </member> <member name="P:Hyak.Common.Properties.Resources.ExceptionRetryHandlerMissing"> <summary> Looks up a localized string similar to Retry handler is not present in the HttpClient handler stack.. </summary> </member> <member name="P:Hyak.Common.Properties.Resources.ExceptionRetryManagerAlreadySet"> <summary> Looks up a localized string similar to The RetryManager is already set.. </summary> </member> <member name="P:Hyak.Common.Properties.Resources.ExceptionRetryManagerNotSet"> <summary> Looks up a localized string similar to The default RetryManager has not been set. Set it by invoking the RetryManager.SetDefault static method, or if you are using declarative configuration, you can invoke the RetryPolicyFactory.CreateDefault() method to automatically create the retry manager from the configuration file.. </summary> </member> <member name="P:Hyak.Common.Properties.Resources.ResponseStatusCodeError"> <summary> Looks up a localized string similar to Response status code indicates server error: {0} ({1}).. </summary> </member> <member name="P:Hyak.Common.Properties.Resources.RetryLimitExceeded"> <summary> Looks up a localized string similar to The action has exceeded its defined retry limit.. </summary> </member> <member name="P:Hyak.Common.Properties.Resources.RetryStrategyNotFound"> <summary> Looks up a localized string similar to The retry strategy with name '{0}' cannot be found.. </summary> </member> <member name="P:Hyak.Common.Properties.Resources.StringCannotBeEmpty"> <summary> Looks up a localized string similar to The specified string argument {0} must not be empty.. </summary> </member> <member name="P:Hyak.Common.Properties.Resources.TaskCannotBeNull"> <summary> Looks up a localized string similar to The specified argument '{0}' cannot return a null task when invoked.. </summary> </member> <member name="P:Hyak.Common.Properties.Resources.TaskMustBeScheduled"> <summary> Looks up a localized string similar to The specified argument '{0}' must return a scheduled task (also known as "hot" task) when invoked.. </summary> </member> <member name="T:Hyak.Common.TransientFaultHandling.AsyncExecution`1"> <summary> Handles the execution and retries of the user-initiated task. </summary> <typeparam name="TResult">The result type of the user-initiated task.</typeparam> </member> <member name="T:Hyak.Common.TransientFaultHandling.AsyncExecution"> <summary> Provides a wrapper for a non-generic <see cref="T:System.Threading.Tasks.Task"/> and calls into the pipeline to retry only the generic version of the <see cref="T:System.Threading.Tasks.Task"/>. </summary> </member> <member name="M:Hyak.Common.TransientFaultHandling.AsyncExecution.StartAsGenericTask(System.Func{System.Threading.Tasks.Task})"> <summary> Wraps the non-generic <see cref="T:System.Threading.Tasks.Task"/> into a generic <see cref="T:System.Threading.Tasks.Task"/>. </summary> <param name="taskAction">The task to wrap.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> that wraps the non-generic <see cref="T:System.Threading.Tasks.Task"/>.</returns> </member> <member name="T:Hyak.Common.TransientFaultHandling.DefaultHttpErrorDetectionStrategy"> <summary> Default Http error detection strategy based on Http Status Code. </summary> </member> <member name="T:Hyak.Common.TransientFaultHandling.ITransientErrorDetectionStrategy"> <summary> Defines an interface that must be implemented by custom components responsible for detecting specific transient conditions. </summary> </member> <member name="M:Hyak.Common.TransientFaultHandling.ITransientErrorDetectionStrategy.IsTransient(System.Exception)"> <summary> Determines whether the specified exception represents a transient failure that can be compensated by a retry. </summary> <param name="ex">The exception object to be verified.</param> <returns>true if the specified exception is considered as transient; otherwise, false.</returns> </member> <member name="M:Hyak.Common.TransientFaultHandling.DefaultHttpErrorDetectionStrategy.IsTransient(System.Exception)"> <summary> Returns true if status code in HttpRequestExceptionWithStatus exception is greater than or equal to 500 and not NotImplemented (501) or HttpVersionNotSupported (505). </summary> <param name="ex">Exception to check against.</param> <returns>True if exception is transient otherwise false.</returns> </member> <member name="T:Hyak.Common.TransientFaultHandling.ExponentialBackoff"> <summary> A retry strategy with backoff parameters for calculating the exponential delay between retries. </summary> </member> <member name="T:Hyak.Common.TransientFaultHandling.RetryStrategy"> <summary> Represents a retry strategy that determines the number of retry attempts and the interval between retries. </summary> </member> <member name="F:Hyak.Common.TransientFaultHandling.RetryStrategy.DefaultClientRetryCount"> <summary> Represents the default number of retry attempts. </summary> </member> <member name="F:Hyak.Common.TransientFaultHandling.RetryStrategy.DefaultClientBackoff"> <summary> Represents the default amount of time used when calculating a random delta in the exponential delay between retries. </summary> </member> <member name="F:Hyak.Common.TransientFaultHandling.RetryStrategy.DefaultMaxBackoff"> <summary> Represents the default maximum amount of time used when calculating the exponential delay between retries. </summary> </member> <member name="F:Hyak.Common.TransientFaultHandling.RetryStrategy.DefaultMinBackoff"> <summary> Represents the default minimum amount of time used when calculating the exponential delay between retries. </summary> </member> <member name="F:Hyak.Common.TransientFaultHandling.RetryStrategy.DefaultRetryInterval"> <summary> Represents the default interval between retries. </summary> </member> <member name="F:Hyak.Common.TransientFaultHandling.RetryStrategy.DefaultRetryIncrement"> <summary> Represents the default time increment between retry attempts in the progressive delay policy. </summary> </member> <member name="F:Hyak.Common.TransientFaultHandling.RetryStrategy.DefaultFirstFastRetry"> <summary> Represents the default flag indicating whether the first retry attempt will be made immediately, whereas subsequent retries will remain subject to the retry interval. </summary> </member> <member name="M:Hyak.Common.TransientFaultHandling.RetryStrategy.#ctor(System.String,System.Boolean)"> <summary> Initializes a new instance of the <see cref="T:Hyak.Common.TransientFaultHandling.RetryStrategy"/> class. </summary> <param name="name">The name of the retry strategy.</param> <param name="firstFastRetry">true to immediately retry in the first attempt; otherwise, false. The subsequent retries will remain subject to the configured retry interval.</param> </member> <member name="M:Hyak.Common.TransientFaultHandling.RetryStrategy.GetShouldRetry"> <summary> Returns the corresponding ShouldRetry delegate. </summary> <returns>The ShouldRetry delegate.</returns> </member> <member name="P:Hyak.Common.TransientFaultHandling.RetryStrategy.NoRetry"> <summary> Returns a default policy that performs no retries, but invokes the action only once. </summary> </member> <member name="P:Hyak.Common.TransientFaultHandling.RetryStrategy.DefaultFixed"> <summary> Returns a default policy that implements a fixed retry interval configured with the <see cref="F:Hyak.Common.TransientFaultHandling.RetryStrategy.DefaultClientRetryCount"/> and <see cref="F:Hyak.Common.TransientFaultHandling.RetryStrategy.DefaultRetryInterval"/> parameters. The default retry policy treats all caught exceptions as transient errors. </summary> </member> <member name="P:Hyak.Common.TransientFaultHandling.RetryStrategy.DefaultProgressive"> <summary> Returns a default policy that implements a progressive retry interval configured with the <see cref="F:Hyak.Common.TransientFaultHandling.RetryStrategy.DefaultClientRetryCount"/>, <see cref="F:Hyak.Common.TransientFaultHandling.RetryStrategy.DefaultRetryInterval"/>, and <see cref="F:Hyak.Common.TransientFaultHandling.RetryStrategy.DefaultRetryIncrement"/> parameters. The default retry policy treats all caught exceptions as transient errors. </summary> </member> <member name="P:Hyak.Common.TransientFaultHandling.RetryStrategy.DefaultExponential"> <summary> Returns a default policy that implements a random exponential retry interval configured with the <see cref="F:Hyak.Common.TransientFaultHandling.RetryStrategy.DefaultClientRetryCount"/>, <see cref="F:Hyak.Common.TransientFaultHandling.RetryStrategy.DefaultMinBackoff"/>, <see cref="F:Hyak.Common.TransientFaultHandling.RetryStrategy.DefaultMaxBackoff"/>, and <see cref="F:Hyak.Common.TransientFaultHandling.RetryStrategy.DefaultClientBackoff"/> parameters. The default retry policy treats all caught exceptions as transient errors. </summary> </member> <member name="P:Hyak.Common.TransientFaultHandling.RetryStrategy.FastFirstRetry"> <summary> Gets or sets a value indicating whether the first retry attempt will be made immediately, whereas subsequent retries will remain subject to the retry interval. </summary> </member> <member name="P:Hyak.Common.TransientFaultHandling.RetryStrategy.Name"> <summary> Gets the name of the retry strategy. </summary> </member> <member name="M:Hyak.Common.TransientFaultHandling.ExponentialBackoff.#ctor"> <summary> Initializes a new instance of the <see cref="T:Hyak.Common.TransientFaultHandling.ExponentialBackoff"/> class. </summary> </member> <member name="M:Hyak.Common.TransientFaultHandling.ExponentialBackoff.#ctor(System.Int32,System.TimeSpan,System.TimeSpan,System.TimeSpan)"> <summary> Initializes a new instance of the <see cref="T:Hyak.Common.TransientFaultHandling.ExponentialBackoff"/> class with the specified retry settings. </summary> <param name="retryCount">The maximum number of retry attempts.</param> <param name="minBackoff">The minimum backoff time</param> <param name="maxBackoff">The maximum backoff time.</param> <param name="deltaBackoff">The value that will be used to calculate a random delta in the exponential delay between retries.</param> </member> <member name="M:Hyak.Common.TransientFaultHandling.ExponentialBackoff.#ctor(System.String,System.Int32,System.TimeSpan,System.TimeSpan,System.TimeSpan)"> <summary> Initializes a new instance of the <see cref="T:Hyak.Common.TransientFaultHandling.ExponentialBackoff"/> class with the specified name and retry settings. </summary> <param name="name">The name of the retry strategy.</param> <param name="retryCount">The maximum number of retry attempts.</param> <param name="minBackoff">The minimum backoff time</param> <param name="maxBackoff">The maximum backoff time.</param> <param name="deltaBackoff">The value that will be used to calculate a random delta in the exponential delay between retries.</param> </member> <member name="M:Hyak.Common.TransientFaultHandling.ExponentialBackoff.#ctor(System.String,System.Int32,System.TimeSpan,System.TimeSpan,System.TimeSpan,System.Boolean)"> <summary> Initializes a new instance of the <see cref="T:Hyak.Common.TransientFaultHandling.ExponentialBackoff"/> class with the specified name, retry settings, and fast retry option. </summary> <param name="name">The name of the retry strategy.</param> <param name="retryCount">The maximum number of retry attempts.</param> <param name="minBackoff">The minimum backoff time</param> <param name="maxBackoff">The maximum backoff time.</param> <param name="deltaBackoff">The value that will be used to calculate a random delta in the exponential delay between retries.</param> <param name="firstFastRetry">true to immediately retry in the first attempt; otherwise, false. The subsequent retries will remain subject to the configured retry interval.</param> </member> <member name="M:Hyak.Common.TransientFaultHandling.ExponentialBackoff.GetShouldRetry"> <summary> Returns the corresponding ShouldRetry delegate. </summary> <returns>The ShouldRetry delegate.</returns> </member> <member name="T:Hyak.Common.TransientFaultHandling.FixedInterval"> <summary> Represents a retry strategy with a specified number of retry attempts and a default, fixed time interval between retries. </summary> </member> <member name="M:Hyak.Common.TransientFaultHandling.FixedInterval.#ctor"> <summary> Initializes a new instance of the <see cref="T:Hyak.Common.TransientFaultHandling.FixedInterval"/> class. </summary> </member> <member name="M:Hyak.Common.TransientFaultHandling.FixedInterval.#ctor(System.Int32)"> <summary> Initializes a new instance of the <see cref="T:Hyak.Common.TransientFaultHandling.FixedInterval"/> class with the specified number of retry attempts. </summary> <param name="retryCount">The number of retry attempts.</param> </member> <member name="M:Hyak.Common.TransientFaultHandling.FixedInterval.#ctor(System.Int32,System.TimeSpan)"> <summary> Initializes a new instance of the <see cref="T:Hyak.Common.TransientFaultHandling.FixedInterval"/> class with the specified number of retry attempts and time interval. </summary> <param name="retryCount">The number of retry attempts.</param> <param name="retryInterval">The time interval between retries.</param> </member> <member name="M:Hyak.Common.TransientFaultHandling.FixedInterval.#ctor(System.String,System.Int32,System.TimeSpan)"> <summary> Initializes a new instance of the <see cref="T:Hyak.Common.TransientFaultHandling.FixedInterval"/> class with the specified number of retry attempts, time interval, and retry strategy. </summary> <param name="name">The retry strategy name.</param> <param name="retryCount">The number of retry attempts.</param> <param name="retryInterval">The time interval between retries.</param> </member> <member name="M:Hyak.Common.TransientFaultHandling.FixedInterval.#ctor(System.String,System.Int32,System.TimeSpan,System.Boolean)"> <summary> Initializes a new instance of the <see cref="T:Hyak.Common.TransientFaultHandling.FixedInterval"/> class with the specified number of retry attempts, time interval, retry strategy, and fast start option. </summary> <param name="name">The retry strategy name.</param> <param name="retryCount">The number of retry attempts.</param> <param name="retryInterval">The time interval between retries.</param> <param name="firstFastRetry">true to immediately retry in the first attempt; otherwise, false. The subsequent retries will remain subject to the configured retry interval.</param> </member> <member name="M:Hyak.Common.TransientFaultHandling.FixedInterval.GetShouldRetry"> <summary> Returns the corresponding ShouldRetry delegate. </summary> <returns>The ShouldRetry delegate.</returns> </member> <member name="T:Hyak.Common.TransientFaultHandling.Guard"> <summary> Implements the common guard methods. </summary> </member> <member name="M:Hyak.Common.TransientFaultHandling.Guard.ArgumentNotNullOrEmptyString(System.String,System.String)"> <summary> Checks a string argument to ensure that it isn't null or empty. </summary> <param name="argumentValue">The argument value to check.</param> <param name="argumentName">The name of the argument.</param> <returns>The return value should be ignored. It is intended to be used only when validating arguments during instance creation (for example, when calling the base constructor).</returns> </member> <member name="M:Hyak.Common.TransientFaultHandling.Guard.ArgumentNotNull(System.Object,System.String)"> <summary> Checks an argument to ensure that it isn't null. </summary> <param name="argumentValue">The argument value to check.</param> <param name="argumentName">The name of the argument.</param> <returns>The return value should be ignored. It is intended to be used only when validating arguments during instance creation (for example, when calling the base constructor).</returns> </member> <member name="M:Hyak.Common.TransientFaultHandling.Guard.ArgumentNotNegativeValue(System.Int32,System.String)"> <summary> Checks an argument to ensure that its 32-bit signed value isn't negative. </summary> <param name="argumentValue">The <see cref="T:System.Int32"/> value of the argument.</param> <param name="argumentName">The name of the argument for diagnostic purposes.</param> </member> <member name="M:Hyak.Common.TransientFaultHandling.Guard.ArgumentNotNegativeValue(System.Int64,System.String)"> <summary> Checks an argument to ensure that its 64-bit signed value isn't negative. </summary> <param name="argumentValue">The <see cref="T:System.Int64"/> value of the argument.</param> <param name="argumentName">The name of the argument for diagnostic purposes.</param> </member> <member name="M:Hyak.Common.TransientFaultHandling.Guard.ArgumentNotGreaterThan(System.Double,System.Double,System.String)"> <summary> Checks an argument to ensure that its value doesn't exceed the specified ceiling baseline. </summary> <param name="argumentValue">The <see cref="T:System.Double"/> value of the argument.</param> <param name="ceilingValue">The <see cref="T:System.Double"/> ceiling value of the argument.</param> <param name="argumentName">The name of the argument for diagnostic purposes.</param> </member> <member name="T:Hyak.Common.TransientFaultHandling.HttpRequestExceptionWithStatus"> <summary> Inherits HttpRequestException adding HttpStatusCode to the exception. </summary> </member> <member name="M:Hyak.Common.TransientFaultHandling.HttpRequestExceptionWithStatus.#ctor"> <summary> Initializes a new instance of the <see cref="T:Hyak.Common.TransientFaultHandling.HttpRequestExceptionWithStatus"/> class. </summary> </member> <member name="M:Hyak.Common.TransientFaultHandling.HttpRequestExceptionWithStatus.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Hyak.Common.TransientFaultHandling.HttpRequestExceptionWithStatus"/> class with a specific message that describes the current exception. </summary> <param name="message">A message that describes the current exception.</param> </member> <member name="M:Hyak.Common.TransientFaultHandling.HttpRequestExceptionWithStatus.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Hyak.Common.TransientFaultHandling.HttpRequestExceptionWithStatus"/> class with a specific message that describes the current exception and an inner exception. </summary> <param name="message">A message that describes the current exception.</param> <param name="inner">The inner exception.</param> </member> <member name="P:Hyak.Common.TransientFaultHandling.HttpRequestExceptionWithStatus.StatusCode"> <summary> Http status code. </summary> </member> <member name="T:Hyak.Common.TransientFaultHandling.Incremental"> <summary> A retry strategy with a specified number of retry attempts and an incremental time interval between retries. </summary> </member> <member name="M:Hyak.Common.TransientFaultHandling.Incremental.#ctor"> <summary> Initializes a new instance of the <see cref="T:Hyak.Common.TransientFaultHandling.Incremental"/> class. </summary> </member> <member name="M:Hyak.Common.TransientFaultHandling.Incremental.#ctor(System.Int32,System.TimeSpan,System.TimeSpan)"> <summary> Initializes a new instance of the <see cref="T:Hyak.Common.TransientFaultHandling.Incremental"/> class with the specified retry settings. </summary> <param name="retryCount">The number of retry attempts.</param> <param name="initialInterval">The initial interval that will apply for the first retry.</param> <param name="increment">The incremental time value that will be used to calculate the progressive delay between retries.</param> </member> <member name="M:Hyak.Common.TransientFaultHandling.Incremental.#ctor(System.String,System.Int32,System.TimeSpan,System.TimeSpan)"> <summary> Initializes a new instance of the <see cref="T:Hyak.Common.TransientFaultHandling.Incremental"/> class with the specified name and retry settings. </summary> <param name="name">The retry strategy name.</param> <param name="retryCount">The number of retry attempts.</param> <param name="initialInterval">The initial interval that will apply for the first retry.</param> <param name="increment">The incremental time value that will be used to calculate the progressive delay between retries.</param> </member> <member name="M:Hyak.Common.TransientFaultHandling.Incremental.#ctor(System.String,System.Int32,System.TimeSpan,System.TimeSpan,System.Boolean)"> <summary> Initializes a new instance of the <see cref="T:Hyak.Common.TransientFaultHandling.Incremental"/> class with the specified number of retry attempts, time interval, retry strategy, and fast start option. </summary> <param name="name">The retry strategy name.</param> <param name="retryCount">The number of retry attempts.</param> <param name="initialInterval">The initial interval that will apply for the first retry.</param> <param name="increment">The incremental time value that will be used to calculate the progressive delay between retries.</param> <param name="firstFastRetry">true to immediately retry in the first attempt; otherwise, false. The subsequent retries will remain subject to the configured retry interval.</param> </member> <member name="M:Hyak.Common.TransientFaultHandling.Incremental.GetShouldRetry"> <summary> Returns the corresponding ShouldRetry delegate. </summary> <returns>The ShouldRetry delegate.</returns> </member> <member name="T:Hyak.Common.TransientFaultHandling.RetryingEventArgs"> <summary> Contains information that is required for the <see cref="E:Hyak.Common.TransientFaultHandling.RetryPolicy.Retrying"/> event. </summary> </member> <member name="M:Hyak.Common.TransientFaultHandling.RetryingEventArgs.#ctor(System.Int32,System.TimeSpan,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Hyak.Common.TransientFaultHandling.RetryingEventArgs"/> class. </summary> <param name="currentRetryCount">The current retry attempt count.</param> <param name="delay">The delay that indicates how long the current thread will be suspended before the next iteration is invoked.</param> <param name="lastException">The exception that caused the retry conditions to occur.</param> </member> <member name="P:Hyak.Common.TransientFaultHandling.RetryingEventArgs.CurrentRetryCount"> <summary> Gets the current retry count. </summary> </member> <member name="P:Hyak.Common.TransientFaultHandling.RetryingEventArgs.Delay"> <summary> Gets the delay that indicates how long the current thread will be suspended before the next iteration is invoked. </summary> </member> <member name="P:Hyak.Common.TransientFaultHandling.RetryingEventArgs.LastException"> <summary> Gets the exception that caused the retry conditions to occur. </summary> </member> <member name="T:Hyak.Common.TransientFaultHandling.RetryLimitExceededException"> <summary> The special type of exception that provides managed exit from a retry loop. The user code can use this exception to notify the retry policy that no further retry attempts are required. </summary> </member> <member name="M:Hyak.Common.TransientFaultHandling.RetryLimitExceededException.#ctor"> <summary> Initializes a new instance of the <see cref="T:Hyak.Common.TransientFaultHandling.RetryLimitExceededException"/> class with a default error message. </summary> </member> <member name="M:Hyak.Common.TransientFaultHandling.RetryLimitExceededException.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Hyak.Common.TransientFaultHandling.RetryLimitExceededException"/> class with a specified error message. </summary> <param name="message">The message that describes the error.</param> </member> <member name="M:Hyak.Common.TransientFaultHandling.RetryLimitExceededException.#ctor(System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Hyak.Common.TransientFaultHandling.RetryLimitExceededException"/> class with a reference to the inner exception that is the cause of this exception. </summary> <param name="innerException">The exception that is the cause of the current exception.</param> </member> <member name="M:Hyak.Common.TransientFaultHandling.RetryLimitExceededException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Hyak.Common.TransientFaultHandling.RetryLimitExceededException"/> class with a specified error message and inner exception. </summary> <param name="message">The message that describes the error.</param> <param name="innerException">The exception that is the cause of the current exception.</param> </member> <member name="T:Hyak.Common.TransientFaultHandling.RetryManager"> <summary> Provides the entry point to the retry functionality. </summary> </member> <member name="M:Hyak.Common.TransientFaultHandling.RetryManager.SetDefault(Hyak.Common.TransientFaultHandling.RetryManager,System.Boolean)"> <summary> Sets the specified retry manager as the default retry manager. </summary> <param name="retryManager">The retry manager.</param> <param name="throwIfSet">true to throw an exception if the manager is already set; otherwise, false. Defaults to <see langword="true"/>.</param> <exception cref="T:System.InvalidOperationException">The singleton is already set and <paramref name="throwIfSet"/> is true.</exception> </member> <member name="M:Hyak.Common.TransientFaultHandling.RetryManager.#ctor(System.Collections.Generic.IEnumerable{Hyak.Common.TransientFaultHandling.RetryStrategy})"> <summary> Initializes a new instance of the <see cref="T:Hyak.Common.TransientFaultHandling.RetryManager"/> class. </summary> <param name="retryStrategies">The complete set of retry strategies.</param> </member> <member name="M:Hyak.Common.TransientFaultHandling.RetryManager.#ctor(System.Collections.Generic.IEnumerable{Hyak.Common.TransientFaultHandling.RetryStrategy},System.String)"> <summary> Initializes a new instance of the <see cref="T:Hyak.Common.TransientFaultHandling.RetryManager"/> class with the specified retry strategies and default retry strategy name. </summary> <param name="retryStrategies">The complete set of retry strategies.</param> <param name="defaultRetryStrategyName">The default retry strategy.</param> </member> <member name="M:Hyak.Common.TransientFaultHandling.RetryManager.#ctor(System.Collections.Generic.IEnumerable{Hyak.Common.TransientFaultHandling.RetryStrategy},System.String,System.Collections.Generic.IDictionary{System.String,System.String})"> <summary> Initializes a new instance of the <see cref="T:Hyak.Common.TransientFaultHandling.RetryManager"/> class with the specified retry strategies and defaults. </summary> <param name="retryStrategies">The complete set of retry strategies.</param> <param name="defaultRetryStrategyName">The default retry strategy.</param> <param name="defaultRetryStrategyNamesMap">The names of the default strategies for different technologies.</param> </member> <member name="M:Hyak.Common.TransientFaultHandling.RetryManager.GetRetryPolicy``1"> <summary> Returns a retry policy with the specified error detection strategy and the default retry strategy defined in the configuration. </summary> <typeparam name="T">The type that implements the <see cref="T:Hyak.Common.TransientFaultHandling.ITransientErrorDetectionStrategy"/> interface that is responsible for detecting transient conditions.</typeparam> <returns>A new retry policy with the specified error detection strategy and the default retry strategy defined in the configuration.</returns> </member> <member name="M:Hyak.Common.TransientFaultHandling.RetryManager.GetRetryPolicy``1(System.String)"> <summary> Returns a retry policy with the specified error detection strategy and retry strategy. </summary> <typeparam name="T">The type that implements the <see cref="T:Hyak.Common.TransientFaultHandling.ITransientErrorDetectionStrategy"/> interface that is responsible for detecting transient conditions.</typeparam> <param name="retryStrategyName">The retry strategy name, as defined in the configuration.</param> <returns>A new retry policy with the specified error detection strategy and the default retry strategy defined in the configuration.</returns> </member> <member name="M:Hyak.Common.TransientFaultHandling.RetryManager.GetRetryStrategy"> <summary> Returns the default retry strategy defined in the configuration. </summary> <returns>The retry strategy that matches the default strategy.</returns> </member> <member name="M:Hyak.Common.TransientFaultHandling.RetryManager.GetRetryStrategy(System.String)"> <summary> Returns the retry strategy that matches the specified name. </summary> <param name="retryStrategyName">The retry strategy name.</param> <returns>The retry strategy that matches the specified name.</returns> </member> <member name="M:Hyak.Common.TransientFaultHandling.RetryManager.GetDefaultRetryStrategy(System.String)"> <summary> Returns the retry strategy for the specified technology. </summary> <param name="technology">The technology to get the default retry strategy for.</param> <returns>The retry strategy for the specified technology.</returns> </member> <member name="P:Hyak.Common.TransientFaultHandling.RetryManager.Instance"> <summary> Gets the default <see cref="T:Hyak.Common.TransientFaultHandling.RetryManager"/> for the application. </summary> <remarks>You can update the default retry manager by calling the <see cref="M:Hyak.Common.TransientFaultHandling.RetryManager.SetDefault(Hyak.Common.TransientFaultHandling.RetryManager,System.Boolean)"/> method.</remarks> </member> <member name="P:Hyak.Common.TransientFaultHandling.RetryManager.DefaultRetryStrategyName"> <summary> Gets or sets the default retry strategy name. </summary> </member> <member name="T:Hyak.Common.TransientFaultHandling.RetryPolicy"> <summary> Provides the base implementation of the retry mechanism for unreliable actions and transient conditions. </summary> </member> <member name="M:Hyak.Common.TransientFaultHandling.RetryPolicy.#ctor(Hyak.Common.TransientFaultHandling.ITransientErrorDetectionStrategy,Hyak.Common.TransientFaultHandling.RetryStrategy)"> <summary> Initializes a new instance of the <see cref="T:Hyak.Common.TransientFaultHandling.RetryPolicy"/> class with the specified number of retry attempts and parameters defining the progressive delay between retries. </summary> <param name="errorDetectionStrategy">The <see cref="T:Hyak.Common.TransientFaultHandling.ITransientErrorDetectionStrategy"/> that is responsible for detecting transient conditions.</param> <param name="retryStrategy">The strategy to use for this retry policy.</param> </member> <member name="M:Hyak.Common.TransientFaultHandling.RetryPolicy.#ctor(Hyak.Common.TransientFaultHandling.ITransientErrorDetectionStrategy,System.Int32)"> <summary> Initializes a new instance of the <see cref="T:Hyak.Common.TransientFaultHandling.RetryPolicy"/> class with the specified number of retry attempts and default fixed time interval between retries. </summary> <param name="errorDetectionStrategy">The <see cref="T:Hyak.Common.TransientFaultHandling.ITransientErrorDetectionStrategy"/> that is responsible for detecting transient conditions.</param> <param name="retryCount">The number of retry attempts.</param> </member> <member name="M:Hyak.Common.TransientFaultHandling.RetryPolicy.#ctor(Hyak.Common.TransientFaultHandling.ITransientErrorDetectionStrategy,System.Int32,System.TimeSpan)"> <summary> Initializes a new instance of the <see cref="T:Hyak.Common.TransientFaultHandling.RetryPolicy"/> class with the specified number of retry attempts and fixed time interval between retries. </summary> <param name="errorDetectionStrategy">The <see cref="T:Hyak.Common.TransientFaultHandling.ITransientErrorDetectionStrategy"/> that is responsible for detecting transient conditions.</param> <param name="retryCount">The number of retry attempts.</param> <param name="retryInterval">The interval between retries.</param> </member> <member name="M:Hyak.Common.TransientFaultHandling.RetryPolicy.#ctor(Hyak.Common.TransientFaultHandling.ITransientErrorDetectionStrategy,System.Int32,System.TimeSpan,System.TimeSpan,System.TimeSpan)"> <summary> Initializes a new instance of the <see cref="T:Hyak.Common.TransientFaultHandling.RetryPolicy"/> class with the specified number of retry attempts and backoff parameters for calculating the exponential delay between retries. </summary> <param name="errorDetectionStrategy">The <see cref="T:Hyak.Common.TransientFaultHandling.ITransientErrorDetectionStrategy"/> that is responsible for detecting transient conditions.</param> <param name="retryCount">The number of retry attempts.</param> <param name="minBackoff">The minimum backoff time.</param> <param name="maxBackoff">The maximum backoff time.</param> <param name="deltaBackoff">The time value that will be used to calculate a random delta in the exponential delay between retries.</param> </member> <member name="M:Hyak.Common.TransientFaultHandling.RetryPolicy.#ctor(Hyak.Common.TransientFaultHandling.ITransientErrorDetectionStrategy,System.Int32,System.TimeSpan,System.TimeSpan)"> <summary> Initializes a new instance of the <see cref="T:Hyak.Common.TransientFaultHandling.RetryPolicy"/> class with the specified number of retry attempts and parameters defining the progressive delay between retries. </summary> <param name="errorDetectionStrategy">The <see cref="T:Hyak.Common.TransientFaultHandling.ITransientErrorDetectionStrategy"/> that is responsible for detecting transient conditions.</param> <param name="retryCount">The number of retry attempts.</param> <param name="initialInterval">The initial interval that will apply for the first retry.</param> <param name="increment">The incremental time value that will be used to calculate the progressive delay between retries.</param> </member> <member name="M:Hyak.Common.TransientFaultHandling.RetryPolicy.ExecuteAction(System.Action)"> <summary> Repetitively executes the specified action while it satisfies the current retry policy. </summary> <param name="action">A delegate that represents the executable action that doesn't return any results.</param> </member> <member name="M:Hyak.Common.TransientFaultHandling.RetryPolicy.ExecuteAction``1(System.Func{``0})"> <summary> Repetitively executes the specified action while it satisfies the current retry policy. </summary> <typeparam name="TResult">The type of result expected from the executable action.</typeparam> <param name="func">A delegate that represents the executable action that returns the result of type <typeparamref name="TResult"/>.</param> <returns>The result from the action.</returns> </member> <member name="M:Hyak.Common.TransientFaultHandling.RetryPolicy.ExecuteAsync(System.Func{System.Threading.Tasks.Task})"> <summary> Repetitively executes the specified asynchronous task while it satisfies the current retry policy. </summary> <param name="taskAction">A function that returns a started task (also known as "hot" task).</param> <returns> A task that will run to completion if the original task completes successfully (either the first time or after retrying transient failures). If the task fails with a non-transient error or the retry limit is reached, the returned task will transition to a faulted state and the exception must be observed. </returns> </member> <member name="M:Hyak.Common.TransientFaultHandling.RetryPolicy.ExecuteAsync(System.Func{System.Threading.Tasks.Task},System.Threading.CancellationToken)"> <summary> Repetitively executes the specified asynchronous task while it satisfies the current retry policy. </summary> <param name="taskAction">A function that returns a started task (also known as "hot" task).</param> <param name="cancellationToken">The token used to cancel the retry operation. This token does not cancel the execution of the asynchronous task.</param> <returns> Returns a task that will run to completion if the original task completes successfully (either the first time or after retrying transient failures). If the task fails with a non-transient error or the retry limit is reached, the returned task will transition to a faulted state and the exception must be observed. </returns> </member> <member name="M:Hyak.Common.TransientFaultHandling.RetryPolicy.ExecuteAsync``1(System.Func{System.Threading.Tasks.Task{``0}})"> <summary> Repeatedly executes the specified asynchronous task while it satisfies the current retry policy. </summary> <param name="taskFunc">A function that returns a started task (also known as "hot" task).</param> <returns> Returns a task that will run to completion if the original task completes successfully (either the first time or after retrying transient failures). If the task fails with a non-transient error or the retry limit is reached, the returned task will transition to a faulted state and the exception must be observed. </returns> </member> <member name="M:Hyak.Common.TransientFaultHandling.RetryPolicy.ExecuteAsync``1(System.Func{System.Threading.Tasks.Task{``0}},System.Threading.CancellationToken)"> <summary> Repeatedly executes the specified asynchronous task while it satisfies the current retry policy. </summary> <param name="taskFunc">A function that returns a started task (also known as "hot" task).</param> <param name="cancellationToken">The token used to cancel the retry operation. This token does not cancel the execution of the asynchronous task.</param> <returns> Returns a task that will run to completion if the original task completes successfully (either the first time or after retrying transient failures). If the task fails with a non-transient error or the retry limit is reached, the returned task will transition to a faulted state and the exception must be observed. </returns> </member> <member name="M:Hyak.Common.TransientFaultHandling.RetryPolicy.OnRetrying(System.Int32,System.Exception,System.TimeSpan)"> <summary> Notifies the subscribers whenever a retry condition is encountered. </summary> <param name="retryCount">The current retry attempt count.</param> <param name="lastError">The exception that caused the retry conditions to occur.</param> <param name="delay">The delay that indicates how long the current thread will be suspended before the next iteration is invoked.</param> </member> <member name="P:Hyak.Common.TransientFaultHandling.RetryPolicy.NoRetry"> <summary> Returns a default policy that performs no retries, but invokes the action only once. </summary> </member> <member name="P:Hyak.Common.TransientFaultHandling.RetryPolicy.DefaultFixed"> <summary> Returns a default policy that implements a fixed retry interval configured with the default <see cref="T:Hyak.Common.TransientFaultHandling.FixedInterval"/> retry strategy. The default retry policy treats all caught exceptions as transient errors. </summary> </member> <member name="P:Hyak.Common.TransientFaultHandling.RetryPolicy.DefaultProgressive"> <summary> Returns a default policy that implements a progressive retry interval configured with the default <see cref="T:Hyak.Common.TransientFaultHandling.Incremental"/> retry strategy. The default retry policy treats all caught exceptions as transient errors. </summary> </member> <member name="P:Hyak.Common.TransientFaultHandling.RetryPolicy.DefaultExponential"> <summary> Returns a default policy that implements a random exponential retry interval configured with the default <see cref="T:Hyak.Common.TransientFaultHandling.FixedInterval"/> retry strategy. The default retry policy treats all caught exceptions as transient errors. </summary> </member> <member name="E:Hyak.Common.TransientFaultHandling.RetryPolicy.Retrying"> <summary> An instance of a callback delegate that will be invoked whenever a retry condition is encountered. </summary> </member> <member name="P:Hyak.Common.TransientFaultHandling.RetryPolicy.RetryStrategy"> <summary> Gets the retry strategy. </summary> </member> <member name="P:Hyak.Common.TransientFaultHandling.RetryPolicy.ErrorDetectionStrategy"> <summary> Gets the instance of the error detection strategy. </summary> </member> <member name="T:Hyak.Common.TransientFaultHandling.RetryPolicy.TransientErrorIgnoreStrategy"> <summary> Implements a strategy that ignores any transient errors. </summary> </member> <member name="M:Hyak.Common.TransientFaultHandling.RetryPolicy.TransientErrorIgnoreStrategy.IsTransient(System.Exception)"> <summary> Always returns false. </summary> <param name="ex">The exception.</param> <returns>Always false.</returns> </member> <member name="T:Hyak.Common.TransientFaultHandling.RetryPolicy.TransientErrorCatchAllStrategy"> <summary> Implements a strategy that treats all exceptions as transient errors. </summary> </member> <member name="M:Hyak.Common.TransientFaultHandling.RetryPolicy.TransientErrorCatchAllStrategy.IsTransient(System.Exception)"> <summary> Always returns true. </summary> <param name="ex">The exception.</param> <returns>Always true.</returns> </member> <member name="T:Hyak.Common.TransientFaultHandling.RetryPolicy`1"> <summary> Provides a generic version of the <see cref="T:Hyak.Common.TransientFaultHandling.RetryPolicy"/> class. </summary> <typeparam name="T">The type that implements the <see cref="T:Hyak.Common.TransientFaultHandling.ITransientErrorDetectionStrategy"/> interface that is responsible for detecting transient conditions.</typeparam> </member> <member name="M:Hyak.Common.TransientFaultHandling.RetryPolicy`1.#ctor(Hyak.Common.TransientFaultHandling.RetryStrategy)"> <summary> Initializes a new instance of the <see cref="T:Hyak.Common.TransientFaultHandling.RetryPolicy`1"/> class with the specified number of retry attempts and parameters defining the progressive delay between retries. </summary> <param name="retryStrategy">The strategy to use for this retry policy.</param> </member> <member name="M:Hyak.Common.TransientFaultHandling.RetryPolicy`1.#ctor(System.Int32)"> <summary> Initializes a new instance of the <see cref="T:Hyak.Common.TransientFaultHandling.RetryPolicy`1"/> class with the specified number of retry attempts and the default fixed time interval between retries. </summary> <param name="retryCount">The number of retry attempts.</param> </member> <member name="M:Hyak.Common.TransientFaultHandling.RetryPolicy`1.#ctor(System.Int32,System.TimeSpan)"> <summary> Initializes a new instance of the <see cref="T:Hyak.Common.TransientFaultHandling.RetryPolicy`1"/> class with the specified number of retry attempts and a fixed time interval between retries. </summary> <param name="retryCount">The number of retry attempts.</param> <param name="retryInterval">The interval between retries.</param> </member> <member name="M:Hyak.Common.TransientFaultHandling.RetryPolicy`1.#ctor(System.Int32,System.TimeSpan,System.TimeSpan,System.TimeSpan)"> <summary> Initializes a new instance of the <see cref="T:Hyak.Common.TransientFaultHandling.RetryPolicy`1"/> class with the specified number of retry attempts and backoff parameters for calculating the exponential delay between retries. </summary> <param name="retryCount">The number of retry attempts.</param> <param name="minBackoff">The minimum backoff time.</param> <param name="maxBackoff">The maximum backoff time.</param> <param name="deltaBackoff">The time value that will be used to calculate a random delta in the exponential delay between retries.</param> </member> <member name="M:Hyak.Common.TransientFaultHandling.RetryPolicy`1.#ctor(System.Int32,System.TimeSpan,System.TimeSpan)"> <summary> Initializes a new instance of the <see cref="T:Hyak.Common.TransientFaultHandling.RetryPolicy`1"/> class with the specified number of retry attempts and parameters defining the progressive delay between retries. </summary> <param name="retryCount">The number of retry attempts.</param> <param name="initialInterval">The initial interval that will apply for the first retry.</param> <param name="increment">The incremental time value that will be used to calculate the progressive delay between retries.</param> </member> <member name="T:Hyak.Common.TransientFaultHandling.ShouldRetry"> <summary> Defines a callback delegate that will be invoked whenever a retry condition is encountered. </summary> <param name="retryCount">The current retry attempt count.</param> <param name="lastException">The exception that caused the retry conditions to occur.</param> <param name="delay">The delay that indicates how long the current thread will be suspended before the next iteration is invoked.</param> <returns><see langword="true"/> if a retry is allowed; otherwise, <see langword="false"/>.</returns> </member> </members> </doc> |