Source

scope.bitbucket.org / scope / _sources / services / ResourceManager / ResourceManager_1_1.txt

Full commit
   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
===================
ResourceManager 1.1
===================

:Generated:  hob rst-doc
:Version:    1.1
:Status:     Published

Service
=======

**ResourceManager** is a tool for monitoring, modifying, and creating
network activity.

ID fields
---------

- Resource IDs: a *resource* is essentially what a URL points to. For each
  unique URL, there is at least one unique resource ID. Resources are kept
  alive as long as something is using them. Note that ResourceManager does
  not retain resources; Opera may free resources if they are not used
  anywhere. An OnUrlUnload event will be sent in this case.

- Request IDs: represents HTTP requests. The purpose of these IDs is to
  make it possible to match related request/response events together.

External ID fields
------------------

- Window IDs are the same in all services, and can be used interchangeably
  everywhere. See *WindowManager* for window-centric commands and events.
- Frame IDs are described in *DocumentManager*.
- Document IDs are also described in *DocumentManager*.



.. code-block:: c

  service ResourceManager
  {
    option (version) = "1.1";

  
    command GetResource(GetResourceArg)                     returns (ResourceData)     =  1;
    command SetReloadPolicy(SetReloadPolicyArg)             returns (Default)          =  2;
    command SetResponseMode(SetResponseModeArg)             returns (Default)          =  3;
    command SetRequestMode(SetRequestModeArg)               returns (Default)          =  4;
    command AddHeaderOverrides(AddHeaderOverridesArg)       returns (Default)          =  5;
    command RemoveHeaderOverrides(RemoveHeaderOverridesArg) returns (Default)          =  6;
    command ClearHeaderOverrides(Default)                   returns (Default)          =  7;
    command CreateRequest(CreateRequestArg)                 returns (ResourceID)       =  8;
    command ClearCache(Default)                             returns (Default)          =  9;
    command GetResourceID(GetResourceIDArg)                 returns (ResourceID)       = 21;
    event   OnUrlLoad                                       returns (UrlLoad)          = 10;
    event   OnUrlFinished                                   returns (UrlFinished)      = 11;
    event   OnUrlRedirect                                   returns (UrlRedirect)      = 12;
    event   OnUrlUnload                                     returns (UrlUnload)        = 13;
    event   OnRequest                                       returns (Request)          = 14;
    event   OnRequestHeader                                 returns (RequestHeader)    = 15;
    event   OnRequestFinished                               returns (RequestFinished)  = 16;
    event   OnRequestRetry                                  returns (RequestRetry)     = 17;
    event   OnResponse                                      returns (Response)         = 18;
    event   OnResponseHeader                                returns (ResponseHeader)   = 19;
    event   OnResponseFinished                              returns (ResponseFinished) = 20;
  }



Commands
========

.. index:: AddHeaderOverrides

``AddHeaderOverrides``
----------------------

::

  command AddHeaderOverrides(AddHeaderOverridesArg) returns (Default) = 5;

Add one or more overrides for HTTP headers. An override can be either adding
a new header, overwriting an existing one, or removing it completely
(if present).


argument:

.. index:: AddHeaderOverridesArg

.. code-block:: c

  message AddHeaderOverridesArg
  {
    /**
     * A list of headers to override. If the 'value' field of any Header
     * is missing, that header will be removed from the request (if present).
     */
    repeated Header headerList = 1;
  }


references:

.. index:: Header

.. code-block:: c

  message Header
  {
    /**
     * The name of the HTTP header, for instance "Accept-Charset".
     */
    required string name  = 1;
    /**
     * The value of the HTTP header, for instance "utf-8" when using
     * Accept-Charset, or "text/html; charset=utf8" for Content-Type.
     */
    required string value = 2;
  }



.. index:: ClearCache

``ClearCache``
--------------

::

  command ClearCache(Default) returns (Default) = 9;

Clear cached resources, or as many of the resources as possible.
(Resources currently in use will not be cleared).






.. index:: ClearHeaderOverrides

``ClearHeaderOverrides``
------------------------

::

  command ClearHeaderOverrides(Default) returns (Default) = 7;

Remove all overrides previously added with AddHeaderOverride.






.. index:: CreateRequest

``CreateRequest``
-----------------

::

  command CreateRequest(CreateRequestArg) returns (ResourceID) = 8;

Create a HTTP request from scratch. It is possible to let Opera choose some
common headers, or control everything by hand.


argument:

.. index:: CreateRequestArg

.. code-block:: c

  message CreateRequestArg
  {
    message Payload
    {
      /**
       * The mime type of this payload.
       */
      required string mimeType   = 1;
      /**
       * The bytes to use as the payload. If this field is set, the stringData
       * can not also be set.
       */
      optional bytes  byteData   = 3;
      /**
       * The string to use as the payload. This is an alternative to using bytes
       * directly. If this field is set, byteData can not also be set.
       */
      optional string stringData = 2;
    }
  
    enum HeaderPolicy
    {
      /**
       * Let's Opera choose request headers depending on how the resource is fetched.
       * Custom headers will be set but only if allowed.
       */
      NORMAL = 1;
      /**
       * Similar to NORMAL but any header in headerList will overwrite those chosen by Opera.
       */
      OVERWRITE = 2;
      /**
       * Replaces all headers with the custom ones. Care must be taken as illegal requests can
       * easily be created with this. It is primarly used for re-running a previous request with
       * the same or slighly altered headers.
       */
      REPLACE = 3;
    }
  
    /**
     * The Window to perform the request in. (The events triggered by this
     * command will appear to come from this Window).
     */
    required uint32       windowID            = 1;
    /**
     * The URL to request.
     */
    required string       url                 = 2;
    /**
     * The HTTP method, e.g. "GET", "POST".
     */
    required string       method              = 3;
    /**
     * Set HTTP headers for this request. When HeaderPolicy NORMAL is chosen,
     * Opera will set reasonable default headers. With HeaderPolicy NORMAL, the
     * following headers can not be set by the caller:
     * 
     * - Accept-Charset
     * - Accept-Encoding
     * - Cache-Control
     * - Connection
     * - Cookie
     * - Cookie2
     * - Date
     * - Expect
     * - Host
     * - If-Range
     * - Pragma
     * - Range
     * - TE
     * - Trailer
     * - Upgrade
     * - User-Agent
     * - Via
     * 
     * Use either HeaderPolicy OVERWRITE, or REPLACE to set these headers.
     */
    repeated Header       headerList          = 4;
    optional Payload      payload             = 5;
    /**
     * Controls how custom headers are handled.
     */
    optional HeaderPolicy headerPolicy        = 6 [default = NORMAL];
    /**
     * Override the global reload policy for this resource.
     */
    optional ReloadPolicy reloadPolicy        = 7 [default = DEFAULT];
    /**
     * Override the global request content mode for this resource.
     */
    optional ContentMode  requestContentMode  = 8;
    /**
     * Override the global response content mode for this resource.
     */
    optional ContentMode  responseContentMode = 9;
  }

returns:

.. index:: ResourceID

.. code-block:: c

  message ResourceID
  {
    required uint32 resourceID = 1;
  }

references:

.. index:: Header

.. code-block:: c

  message Header
  {
    /**
     * The name of the HTTP header, for instance "Accept-Charset".
     */
    required string name  = 1;
    /**
     * The value of the HTTP header, for instance "utf-8" when using
     * Accept-Charset, or "text/html; charset=utf8" for Content-Type.
     */
    required string value = 2;
  }

.. index:: ContentMode

.. code-block:: c

  message ContentMode
  {
    enum Transport
    {
      /**
       * Send the payload as a string.
       * 
       * Selecting this transport mode  will automatically enable decoding,
       * and the string will automatically converted to the correct character
       * encoding.
       * 
       * If this transport mode is used an unsuitable content type, the payload
       * will not be sent (without errors).
       */
      STRING = 1;
      /**
       * Send the payload as bytes. When this transport mode is chosen, character
       * conversion will not be performed. If the payload contains text data, it
       * will be sent in its original encoding.
       */
      BYTES = 2;
      /**
       * Send the payload as a base64-encoded data URI in the string field. When
       * this transport mode is chosen, character conversion will not be performed.
       * If the payload contains text data, it will be sent in its original encoding.
       */
      DATA_URI = 3;
      /**
       * Do not send the payload at all.
       */
      OFF = 4;
    }
  
    /**
     * Indicates how to send the payload.
     */
    optional Transport transport = 1 [default = OFF];
    /**
     * Decode the data (for instance, decompress it, decrypt it, etc). This is
     * unrelated to character encoding.
     */
    optional bool      decode    = 2 [default = false];
    /**
     * Even if other conditions are met, do not send the payload if it
     * exceeds the specified amout (in bytes).
     * 
     * By default, only payloads under one megabyte are sent.
     */
    optional uint32    sizeLimit = 3 [default = 1000000];
  }



.. index:: GetResource

``GetResource``
---------------

::

  command GetResource(GetResourceArg) returns (ResourceData) = 1;

Get ResourceData for a certain resource.

This command provides a way to get data from a resource after
the request has completed, or in cases where there is no request.

It is possible to get the resource with a different content mode
than what has been set by SetResponseMode.


argument:

.. index:: GetResourceArg

.. code-block:: c

  message GetResourceArg
  {
    required uint32      resourceID  = 1;
    /**
     * Use this ContentMode instead of the one configured with
     * SetResponseModeArg (if any).
     */
    optional ContentMode contentMode = 2;
  }

returns:

.. index:: ResourceData

.. code-block:: c

  message ResourceData
  {
    required uint32  resourceID        = 1;
    required string  url               = 2;
    /**
     * The used mime type. This may be different from the mime type
     * advertised in the HTTP headers.
     */
    optional string  mimeType          = 3;
    /**
     * Original character encoding (if applicable).
     */
    optional string  characterEncoding = 4;
    /**
     * Content-Length, as advertised by HTTP headers.
     */
    optional uint32  contentLength     = 5;
    optional Content content           = 6;
  }

references:

.. index:: ContentMode

.. code-block:: c

  message ContentMode
  {
    enum Transport
    {
      /**
       * Send the payload as a string.
       * 
       * Selecting this transport mode  will automatically enable decoding,
       * and the string will automatically converted to the correct character
       * encoding.
       * 
       * If this transport mode is used an unsuitable content type, the payload
       * will not be sent (without errors).
       */
      STRING = 1;
      /**
       * Send the payload as bytes. When this transport mode is chosen, character
       * conversion will not be performed. If the payload contains text data, it
       * will be sent in its original encoding.
       */
      BYTES = 2;
      /**
       * Send the payload as a base64-encoded data URI in the string field. When
       * this transport mode is chosen, character conversion will not be performed.
       * If the payload contains text data, it will be sent in its original encoding.
       */
      DATA_URI = 3;
      /**
       * Do not send the payload at all.
       */
      OFF = 4;
    }
  
    /**
     * Indicates how to send the payload.
     */
    optional Transport transport = 1 [default = OFF];
    /**
     * Decode the data (for instance, decompress it, decrypt it, etc). This is
     * unrelated to character encoding.
     */
    optional bool      decode    = 2 [default = false];
    /**
     * Even if other conditions are met, do not send the payload if it
     * exceeds the specified amout (in bytes).
     * 
     * By default, only payloads under one megabyte are sent.
     */
    optional uint32    sizeLimit = 3 [default = 1000000];
  }

.. index:: Content

.. code-block:: c

  message Content
  {
    /**
     * If BYTES or DATA_URI was chosen as the transport mode, this field
     * contains the size of the data. (If, in addition, decoding was enabled,
     * the field contains the size of the decoded data).
     * 
     * If STRING was chosen as the transport mode, this field contains the
     * string length (regardless of encoding), i.e. the number of characters,
     * not including zero terminator.
     */
    optional uint32 length            = 1;
    /**
     * The (original) character encoding of the data (if applicable).
     */
    optional string characterEncoding = 2;
    /**
     * This field contains the data if BYTES was chosen as the transport
     * mode. If other modes were chosen, this field is not set.
     * 
     * @see ContentMode::Transport
     */
    optional bytes  byteData          = 3;
    /**
     * This field contains the data if either STRING or DATA_URI were chosen
     * as transport mode. If some other mode was chosen, this field is not set.
     * 
     * @see ContentMode::Transport
     */
    optional string stringData        = 4;
  }



.. index:: GetResourceID

``GetResourceID``
-----------------

::

  command GetResourceID(GetResourceIDArg) returns (ResourceID) = 21;

Get the resource ID of a URL that is either in cache, or otherwise in use
(for instance currently being loaded).

In some cases the same resource may have multiple IDs, for instance POST
form results. Trying to get an ID for resources with multiple IDs will
result in an error.

An error will also be returned if the specified URL is not in use. Use
``CreateRequest`` to generate a resource ID in this case.

Note that setting the reload policy to NO_CACHE does not exclude the
use of this command. Setting the reload policy to NO_CACHE does not
prevent resources from entering cache, it merely prevents reloading from
it.

@since 1.1


argument:

.. index:: GetResourceIDArg

.. code-block:: c

  message GetResourceIDArg
  {
    /**
     * The URL of the resource to get the ID for.
     */
    required string url = 1;
  }

returns:

.. index:: ResourceID

.. code-block:: c

  message ResourceID
  {
    required uint32 resourceID = 1;
  }



.. index:: RemoveHeaderOverrides

``RemoveHeaderOverrides``
-------------------------

::

  command RemoveHeaderOverrides(RemoveHeaderOverridesArg) returns (Default) = 6;

Remove overrides previously added with AddHeaderOverrides.


argument:

.. index:: RemoveHeaderOverridesArg

.. code-block:: c

  message RemoveHeaderOverridesArg
  {
    /**
     * A list of header names to remove overrides for. If there is no override
     * for a certain name, it will be ignored.
     */
    repeated string nameList = 1;
  }




.. index:: SetReloadPolicy

``SetReloadPolicy``
-------------------

::

  command SetReloadPolicy(SetReloadPolicyArg) returns (Default) = 2;

Choose whether resources should be allowed to load from cache,
or whether they should be fully downloaded over the network on
each reload.

The default mode is to always load resources fully.


argument:

.. index:: SetReloadPolicyArg

.. code-block:: c

  message SetReloadPolicyArg
  {
    required ReloadPolicy policy = 1;
  }




.. index:: SetRequestMode

``SetRequestMode``
------------------

::

  command SetRequestMode(SetRequestModeArg) returns (Default) = 4;

Choose how (and if) request data should be reported. It's possible
to set a filter with different settings based on MIME type.


argument:

.. index:: SetRequestModeArg

.. code-block:: c

  message SetRequestModeArg
  {
    /**
     * If there is no matching mode for a certain mime type, then this
     * mode will be used. If not present, no data is received by default.
     */
    optional ContentMode defaultContentMode    = 1;
    /**
     * Whenever a resource matches a mime type found in this list, the
     * corresponding ContentMode is used for that resource.
     */
    repeated MimeMode    mimeModeList          = 2;
    /**
     * Whenever an individual part of a multipart/form-data matches a
     * type found in this list, the corresponding ContentMode is used
     * for that part.
     */
    repeated MimeMode    multipartMimeModeList = 3;
  }


references:

.. index:: ContentMode

.. code-block:: c

  message ContentMode
  {
    enum Transport
    {
      /**
       * Send the payload as a string.
       * 
       * Selecting this transport mode  will automatically enable decoding,
       * and the string will automatically converted to the correct character
       * encoding.
       * 
       * If this transport mode is used an unsuitable content type, the payload
       * will not be sent (without errors).
       */
      STRING = 1;
      /**
       * Send the payload as bytes. When this transport mode is chosen, character
       * conversion will not be performed. If the payload contains text data, it
       * will be sent in its original encoding.
       */
      BYTES = 2;
      /**
       * Send the payload as a base64-encoded data URI in the string field. When
       * this transport mode is chosen, character conversion will not be performed.
       * If the payload contains text data, it will be sent in its original encoding.
       */
      DATA_URI = 3;
      /**
       * Do not send the payload at all.
       */
      OFF = 4;
    }
  
    /**
     * Indicates how to send the payload.
     */
    optional Transport transport = 1 [default = OFF];
    /**
     * Decode the data (for instance, decompress it, decrypt it, etc). This is
     * unrelated to character encoding.
     */
    optional bool      decode    = 2 [default = false];
    /**
     * Even if other conditions are met, do not send the payload if it
     * exceeds the specified amout (in bytes).
     * 
     * By default, only payloads under one megabyte are sent.
     */
    optional uint32    sizeLimit = 3 [default = 1000000];
  }

.. index:: MimeMode

.. code-block:: c

  /**
   * Used to override the default ContentMode for resources with a
   * certain mime type.
   */
  message MimeMode
  {
    /**
     * The mime type, for instance 'text/plain'.
     */
    required string      type        = 1;
    /**
     * How to treat this mime type.
     */
    required ContentMode contentMode = 2;
  }



.. index:: SetResponseMode

``SetResponseMode``
-------------------

::

  command SetResponseMode(SetResponseModeArg) returns (Default) = 3;

Choose how (and if) response data should be reported. It's possible
to set a filter with different settings based on MIME type.


argument:

.. index:: SetResponseModeArg

.. code-block:: c

  message SetResponseModeArg
  {
    /**
     * If there is no matching mode for a certain mime type, then this
     * mode will be used. If not present, no data is received by default.
     */
    optional ContentMode defaultContentMode = 1;
    /**
     * Whenever a resource matches a mime type found in this list, the
     * corresponding ContentMode is used for that resource.
     */
    repeated MimeMode    mimeModeList       = 2;
  }


references:

.. index:: ContentMode

.. code-block:: c

  message ContentMode
  {
    enum Transport
    {
      /**
       * Send the payload as a string.
       * 
       * Selecting this transport mode  will automatically enable decoding,
       * and the string will automatically converted to the correct character
       * encoding.
       * 
       * If this transport mode is used an unsuitable content type, the payload
       * will not be sent (without errors).
       */
      STRING = 1;
      /**
       * Send the payload as bytes. When this transport mode is chosen, character
       * conversion will not be performed. If the payload contains text data, it
       * will be sent in its original encoding.
       */
      BYTES = 2;
      /**
       * Send the payload as a base64-encoded data URI in the string field. When
       * this transport mode is chosen, character conversion will not be performed.
       * If the payload contains text data, it will be sent in its original encoding.
       */
      DATA_URI = 3;
      /**
       * Do not send the payload at all.
       */
      OFF = 4;
    }
  
    /**
     * Indicates how to send the payload.
     */
    optional Transport transport = 1 [default = OFF];
    /**
     * Decode the data (for instance, decompress it, decrypt it, etc). This is
     * unrelated to character encoding.
     */
    optional bool      decode    = 2 [default = false];
    /**
     * Even if other conditions are met, do not send the payload if it
     * exceeds the specified amout (in bytes).
     * 
     * By default, only payloads under one megabyte are sent.
     */
    optional uint32    sizeLimit = 3 [default = 1000000];
  }

.. index:: MimeMode

.. code-block:: c

  /**
   * Used to override the default ContentMode for resources with a
   * certain mime type.
   */
  message MimeMode
  {
    /**
     * The mime type, for instance 'text/plain'.
     */
    required string      type        = 1;
    /**
     * How to treat this mime type.
     */
    required ContentMode contentMode = 2;
  }



Events
======

.. index:: OnRequest

``OnRequest``
-------------

::

  event OnRequest returns (Request) = 14;

Fired when a request is created.


message:

.. index:: SetResponseModeArg

.. code-block:: c

  message Request
  {
    required uint32 requestID  = 1;
    required uint32 resourceID = 2;
    required uint32 windowID   = 3;
    optional uint32 frameID    = 4;
    optional uint32 documentID = 5;
    required string url        = 6;
    /**
     * Milliseconds since Unix epoch.
     */
    required double time       = 7;
    required string method     = 8;
  }



.. index:: OnRequestFinished

``OnRequestFinished``
---------------------

::

  event OnRequestFinished returns (RequestFinished) = 16;

Fired after the entire request (including payload, if any) has been
sent.


message:

.. index:: SetResponseModeArg

.. code-block:: c

  message RequestFinished
  {
    required uint32      requestID  = 1;
    required uint32      resourceID = 2;
    /**
     * Milliseconds since Unix epoch.
     */
    required double      time       = 3;
    optional RequestData data       = 4;
  }

references:

.. index:: Content

.. code-block:: c

  message Content
  {
    /**
     * If BYTES or DATA_URI was chosen as the transport mode, this field
     * contains the size of the data. (If, in addition, decoding was enabled,
     * the field contains the size of the decoded data).
     * 
     * If STRING was chosen as the transport mode, this field contains the
     * string length (regardless of encoding), i.e. the number of characters,
     * not including zero terminator.
     */
    optional uint32 length            = 1;
    /**
     * The (original) character encoding of the data (if applicable).
     */
    optional string characterEncoding = 2;
    /**
     * This field contains the data if BYTES was chosen as the transport
     * mode. If other modes were chosen, this field is not set.
     * 
     * @see ContentMode::Transport
     */
    optional bytes  byteData          = 3;
    /**
     * This field contains the data if either STRING or DATA_URI were chosen
     * as transport mode. If some other mode was chosen, this field is not set.
     * 
     * @see ContentMode::Transport
     */
    optional string stringData        = 4;
  }

.. index:: Header

.. code-block:: c

  message Header
  {
    /**
     * The name of the HTTP header, for instance "Accept-Charset".
     */
    required string name  = 1;
    /**
     * The value of the HTTP header, for instance "utf-8" when using
     * Accept-Charset, or "text/html; charset=utf8" for Content-Type.
     */
    required string value = 2;
  }

.. index:: RequestData

.. code-block:: c

  message RequestData
  {
    message Part
    {
      /**
       * In multi-part, each part may have its own headers.
       */
      repeated Header  headerList    = 1;
      /**
       * The length of this part.
       */
      optional uint32  contentLength = 2;
      optional Content content       = 3;
    }
  
    required uint32  requestID         = 1;
    required uint32  resourceID        = 2;
    optional string  mimeType          = 3;
    /**
     * The character encoding of the payload. Not applicable when the
     * payload is of a non-text type.
     * 
     * Example: utf-8
     */
    optional string  characterEncoding = 4;
    optional uint32  contentLength     = 5;
    optional Content content           = 6;
    /**
     * If the payload is multipart, this list contains the
     * individual parts.
     */
    repeated Part    partList          = 7;
  }



.. index:: OnRequestHeader

``OnRequestHeader``
-------------------

::

  event OnRequestHeader returns (RequestHeader) = 15;

Fired after the request headers are composed.


message:

.. index:: SetResponseModeArg

.. code-block:: c

  message RequestHeader
  {
    required uint32 requestID  = 1;
    required uint32 resourceID = 2;
    /**
     * Milliseconds since Unix epoch.
     */
    required double time       = 3;
    required string raw        = 4;
    repeated Header headerList = 5;
  }

references:

.. index:: Header

.. code-block:: c

  message Header
  {
    /**
     * The name of the HTTP header, for instance "Accept-Charset".
     */
    required string name  = 1;
    /**
     * The value of the HTTP header, for instance "utf-8" when using
     * Accept-Charset, or "text/html; charset=utf8" for Content-Type.
     */
    required string value = 2;
  }



.. index:: OnRequestRetry

``OnRequestRetry``
------------------

::

  event OnRequestRetry returns (RequestRetry) = 17;

If pipelining is enabled, a request can sometimes be moved to another
connection if the previous connection failed, for some reason.

In these cases, this event will fire to indicate that we are retrying
the same request under a new requestID.


message:

.. index:: SetResponseModeArg

.. code-block:: c

  message RequestRetry
  {
    required uint32 resourceID    = 1;
    required uint32 fromRequestID = 2;
    required uint32 toRequestID   = 3;
    required double time          = 4;
  }



.. index:: OnResponse

``OnResponse``
--------------

::

  event OnResponse returns (Response) = 18;

Fired when data is first received from the server, before any headers
are parsed.


message:

.. index:: SetResponseModeArg

.. code-block:: c

  message Response
  {
    required uint32 requestID    = 1;
    required uint32 resourceID   = 2;
    /**
     * Milliseconds since Unix epoch.
     */
    required double time         = 3;
    /**
     * HTTP response code, such as 200, 404, etc.
     */
    optional uint32 responseCode = 4;
  }



.. index:: OnResponseFinished

``OnResponseFinished``
----------------------

::

  event OnResponseFinished returns (ResponseFinished) = 20;

Fired when the entire response (including payload) has been downloaded.


message:

.. index:: SetResponseModeArg

.. code-block:: c

  message ResponseFinished
  {
    required uint32       requestID     = 1;
    required uint32       resourceID    = 2;
    /**
     * Milliseconds since Unix epoch.
     */
    required double       time          = 3;
    required uint32       contentLength = 4;
    optional ResourceData data          = 5;
  }

references:

.. index:: Content

.. code-block:: c

  message Content
  {
    /**
     * If BYTES or DATA_URI was chosen as the transport mode, this field
     * contains the size of the data. (If, in addition, decoding was enabled,
     * the field contains the size of the decoded data).
     * 
     * If STRING was chosen as the transport mode, this field contains the
     * string length (regardless of encoding), i.e. the number of characters,
     * not including zero terminator.
     */
    optional uint32 length            = 1;
    /**
     * The (original) character encoding of the data (if applicable).
     */
    optional string characterEncoding = 2;
    /**
     * This field contains the data if BYTES was chosen as the transport
     * mode. If other modes were chosen, this field is not set.
     * 
     * @see ContentMode::Transport
     */
    optional bytes  byteData          = 3;
    /**
     * This field contains the data if either STRING or DATA_URI were chosen
     * as transport mode. If some other mode was chosen, this field is not set.
     * 
     * @see ContentMode::Transport
     */
    optional string stringData        = 4;
  }

.. index:: ResourceData

.. code-block:: c

  message ResourceData
  {
    required uint32  resourceID        = 1;
    required string  url               = 2;
    /**
     * The used mime type. This may be different from the mime type
     * advertised in the HTTP headers.
     */
    optional string  mimeType          = 3;
    /**
     * Original character encoding (if applicable).
     */
    optional string  characterEncoding = 4;
    /**
     * Content-Length, as advertised by HTTP headers.
     */
    optional uint32  contentLength     = 5;
    optional Content content           = 6;
  }



.. index:: OnResponseHeader

``OnResponseHeader``
--------------------

::

  event OnResponseHeader returns (ResponseHeader) = 19;

Fired when headers are received and parsed.


message:

.. index:: SetResponseModeArg

.. code-block:: c

  message ResponseHeader
  {
    required uint32 requestID  = 1;
    required uint32 resourceID = 2;
    /**
     * Milliseconds since Unix epoch.
     */
    required double time       = 3;
    required string raw        = 4;
    repeated Header headerList = 5;
  }

references:

.. index:: Header

.. code-block:: c

  message Header
  {
    /**
     * The name of the HTTP header, for instance "Accept-Charset".
     */
    required string name  = 1;
    /**
     * The value of the HTTP header, for instance "utf-8" when using
     * Accept-Charset, or "text/html; charset=utf8" for Content-Type.
     */
    required string value = 2;
  }



.. index:: OnUrlFinished

``OnUrlFinished``
-----------------

::

  event OnUrlFinished returns (UrlFinished) = 11;

Resource was completely loaded or failed.

No request events should happen after this point.


message:

.. index:: SetResponseModeArg

.. code-block:: c

  message UrlFinished
  {
    enum Result
    {
      /**
       * A URL finished loading, without problems.
       */
      FINISHED = 1;
      /**
       * A URL load failed, e.g. due to connection failure.
       */
      FAILED = 2;
      /**
       * A URL load was stopped, e.g. by user request.
       */
      STOPPED = 3;
    }
  
    required uint32 resourceID        = 1;
    required Result result            = 2;
    /**
     * Milliseconds since Unix epoch.
     */
    required double time              = 3;
    /**
     * The MIME type of the resource. This information might not be available if the server
     * did not specify the MIME type, and if content detection has not yet run (or was unable
     * to detect the type).
     */
    optional string mimeType          = 4;
    /**
     * The character encoding of the resource. This information might not be available if the server
     * did not specify the character encoding, and if character encoding detection has not yet run
     * (or was unable to detect the type).
     */
    optional string characterEncoding = 5;
    /**
     * The size of the body (if any).
     */
    optional uint32 contentLength     = 6;
  }



.. index:: OnUrlLoad

``OnUrlLoad``
-------------

::

  event OnUrlLoad returns (UrlLoad) = 10;

A resource was requested by the browser.

Depending on the protocol used it may result in OnRequest/OnResponse events.
When resource is loaded OnUrlFinished is sent.


message:

.. index:: SetResponseModeArg

.. code-block:: c

  message UrlLoad
  {
    enum URLType
    {
      /**
       * Type not known, should not occur.
       */
      UNKNOWN = 0;
      /**
       * HTTP protocol.
       */
      HTTP = 1;
      /**
       * HTTP protocol with SSL.
       */
      HTTPS = 2;
      /**
       * Local file access.
       */
      FILE = 3;
      /**
       * Data URIs, e.g data:text/plain,mydata
       */
      DATA = 4;
      FTP = 5;
      GOPHER = 6;
      WAIS = 7;
      NEWS = 8;
      SNEWS = 9;
      NEWSATTACHMENT = 10;
      SNEWSATTACHMENT = 11;
      EMAIL = 12;
      ATTACHMENT = 13;
      TELNET = 14;
      MAILTO = 15;
      OPERA = 16;
      JAVASCRIPT = 17;
      CONTENT_ID = 18;
      TN3270 = 19;
      SOURCE = 21;
      CLIENT = 22;
      NNTP = 23;
      NNTPS = 25;
      SHARE = 26;
      GHTTP = 27;
      TV = 28;
      EDITED = 29;
      ERROR = 30;
      DVB = 31;
      TEL = 32;
      MAIL = 33;
      IRC = 34;
      SMS = 35;
      SMSTO = 36;
      CHAT_TRANSFER = 39;
      DEVICE = 40;
      MOUNTPOINT = 41;
      WIDGET = 42;
      OBMLSERVER = 43;
      UNITE = 44;
      INTERNAL = 100;
    }
  
    required uint32  windowID   = 1;
    optional uint32  frameID    = 2;
    optional uint32  documentID = 3;
    required uint32  resourceID = 4;
    /**
     * The URL which which is about to be loaded.
     */
    required string  url        = 5;
    /**
     * The type of URL that was started, this can referer to a specific protocol
     * or a special URL type.
     * 
     * @note More types may be added in the future, make sure the client supports that.
     */
    required URLType urlType    = 6;
    /**
     * Milliseconds since Unix epoch.
     */
    required double  time       = 7;
  }



.. index:: OnUrlRedirect

``OnUrlRedirect``
-----------------

::

  event OnUrlRedirect returns (UrlRedirect) = 12;

Sent when a URL is redirect to another URL.
Contains both the original resource ID and the new resource ID.


message:

.. index:: SetResponseModeArg

.. code-block:: c

  message UrlRedirect
  {
    required uint32 fromResourceID = 1;
    required uint32 toResourceID   = 2;
    /**
     * Milliseconds since Unix epoch.
     */
    required double time           = 3;
  }



.. index:: OnUrlUnload

``OnUrlUnload``
---------------

::

  event OnUrlUnload returns (UrlUnload) = 13;

The specified URL and resource ID is no longer in use
in the browser. Any references to them should be removed.

@note Trying to use the resource ID after this event will not work.


message:

.. index:: SetResponseModeArg

.. code-block:: c

  message UrlUnload
  {
    required uint32 resourceID = 1;
    /**
     * Milliseconds since Unix epoch.
     */
    required double time       = 2;
  }