#include <standardwebsocket.h>
Inheritance diagram for ttv::StandardWebSocketFactory:
Public Member Functions | |
| virtual | ~StandardWebSocketFactory () |
| virtual bool | IsProtocolSupported (const std::string &protocol) |
| virtual TTV_ErrorCode | CreateWebSocket (const std::string &uri, std::shared_ptr< IWebSocket > &result) |
Constructor & Destructor Documentation
◆ ~StandardWebSocketFactory()
|
virtual |
Member Function Documentation
◆ CreateWebSocket()
|
virtual |
Attempts to create an IWebSocket instance that supports the given URI.
- See also
- ttv::RegisterWebSocketFactory
- Parameters
-
[in] uri The full uri to create the socket for. [out] result The resulting IWebSocket instance if it was able to be created.
- Returns
- TTV_EC_SUCCESS: The result has been populated with an IWebSocket instance to use.
- TTV_EC_UNIMPLEMENTED: This factory does not support the protocol.
Implements ttv::IWebSocketFactory.
◆ IsProtocolSupported()
|
virtual |
Determines if this factory supports the given protocol. If the factory claims that is supports the given protocol then it must return a valid ISocket instance from CreateWebSocket().
- Parameters
-
[in] protocol The protocol to check support for.
- Returns
- true if the protocol is supported, false otherwise.
Implements ttv::IWebSocketFactory.
The documentation for this class was generated from the following file:
- modules/core/core_std/include/twitchsdk/core/standardwebsocket.h
