protocol.json

{
  "namespace": "protocol",
  "types": [
    {
      "$ref": "ProtocolHandler",
      "type": "function",
      "description": "Protocol handler",
      "async": false,
      "parameters": [
        {
          "name": "write",
          "type": "Write",
          "description": "Writes chunk of data to the output stream"
        },
        {
          "name": "end",
          "type": "End",
          "description": "End the output stream"
        }
      ]
    },
    {
      "$ref": "Write",
      "type": "function",
      "async": false,
      "parameters": [
        {
          "name": "chunk",
          "type": "ArrayBuffer",
          "description": "Data chunk to be written"
        }
      ]
    },
    {
      "$ref": "End",
      "type": "function",
      "async": false,
      "parameters": []
    }
  ],
  "functions": [
    {
      "name": "registerProtocol",
      "type": "function",
      "description": "registers network protocol handler",
      "async": true,
      "parameters": [
        {
          "name": "scheme",
          "type": "string",
          "description": "The protocol scheme that implementation will handle."
        },
        {
          "name": "handler",
          "type": "ProtocolHandler",
          "description": "Protocol handler for the registered protocol"
        }
      ]
    }
  ],
  "properties": {},
  "events": []
}