admin_setMaxSubscriptionPerWSConn

The setMaxSubscriptionPerWSConn is an administrative method that sets the maximum allowed number of subscriptions per single WebSocket connection. For example, if the maximum number is set to five and a user requests more than five subscriptions through the klay_subscribe API, an error message "Maximum 5 subscriptions are allowed for a WebSocket connection" will be displayed. This feature is supported since Kaia 1.6.0.

JSONRPC: admin_setMaxSubscriptionPerWSConn

Request

application/json

Body

params Limit (integer)[]required

The maximum allowed number of subscriptions per single WebSocket connection.

Responses

200

Return null if the limit is set successfully; otherwise, it returns an error message.

application/json

Schema

Schema

error

object

code int64required

A Number that indicates the error type that occurred. This MUST be an integer.

code	message	description
-32700	Parse error	invalid JSON was received by the server. An error occurred on the server while parsing the JSON text.
-32602	Invalid params	Invalid method parameter(s).

message string

A String providing a short description of the error. The message SHOULD be limited to a concise single sentence.

data string

A Primitive or Structured value that contains additional information about the error. This may be omitted. The value of this member is defined by the Server (e.g. detailed error information, nested errors etc.).

result stringnullable

null if the limit is set successfully; otherwise, it returns an error message.

Example (from schema)

{
  "jsonrpc": "2.0",
  "id": 0,
  "error": {
    "code": -32700,
    "message": "Parse error",
    "data": "string"
  },
  "result": "string"
}

Loading...