mi::rswservices::IWebsocket_handler Class Reference
Description
Web Socket handler interface that when implemented and registered via an extension context will be called whenever events occur on any web socket connection.
Public Member Functions
- virtual void close( const char* session_id) =0
- Called whenever a web socket connection is closed. More...
- virtual void command( const char* session_id) =0
- Called whenever a web socket protocol command is received. More...
- virtual void connect( const char* session_id) =0
- Called whenever a web socket connection is made. More...
Member Functions
- virtual void mi::rswservices::IWebsocket_handler::close( const char* session_id) [pure virtual]
-
Called whenever a web socket connection is closed. Note this will only be called if connect was previously called.
Parameters
- session_id
- The ID of the web socket session the command was received on.
- virtual void mi::rswservices::IWebsocket_handler::command( const char* session_id) [pure virtual]
-
Called whenever a web socket protocol command is received. Note that in this context a command is a protocol command, not a web services command execution request. Calls to this method indicate direct user activity on the web socket connection.
Parameters
- session_id
- The ID of the web socket session the command was received on.
- virtual void mi::rswservices::IWebsocket_handler::connect( const char* session_id) [pure virtual]
-
Called whenever a web socket connection is made. Note that this handler will only be called once a successful client handshake has been completed.
Parameters
- session_id
- The ID of the web socket session the command was received on.