cbrx_connection_closeandlock

Close all connections to a hub and lock it against further use until released by

cbrx_connection_unlock. Other processes that were using these connections will get errors returned if trying to access this hub.

Syntax: see API Call Structure

{

"method": "cbrx_connection_closeandlock", "params": [hub-serial]

}

hub-serial is a string which is the serial number of the hub, each string is guaranteed to be unique.

Returns:

{

"result": true

}
  • Errors

    • If there is an error in the API method then a JSON-RPC Error Object will be returned.

    Example

    Example JSON-RPC request:

    Copy 
    {
      "jsonrpc": "2.0",
      "id": 0,
      "method": "cbrx_connection_closeandlock",
      "params": [
        "DB0074F5"
      ]
    }

    Example successful response:

    Copy 
    {
      "jsonrpc": "2.0",
      "id": 0,
      "result": true
    }