Skip to main content

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 Klaytn 1.6.0.

JSONRPC: admin_setMaxSubscriptionPerWSConn

Request

Body

    method stringrequired

    Default value: admin_setMaxSubscriptionPerWSConn

    Method name

    id int64required

    Default value: 1

    Request ID, Random or Auto incrementation

    jsonrpc stringrequired

    Default value: 2.0

    JSON-RPC Version (2.0)

    params Limit[]required

    The maximum allowed number of subscriptions per single WebSocket connection.

Responses

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

Schema

    jsonrpc stringrequired

    Default value: 2.0

    id int64required

    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.

Loading...
Make this page better