Twitch SDK (Internal)
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ttv::binding::java::JavaWebSocketFactory Class Reference

#include <java_socket.h>

Inheritance diagram for ttv::binding::java::JavaWebSocketFactory:
ttv::IWebSocketFactory ttv::binding::java::JavaSocketFactoryBase

Public Member Functions

 JavaWebSocketFactory (JNIEnv *jEnv, jobject jInstance)
 
virtual ~JavaWebSocketFactory ()
 
virtual bool IsProtocolSupported (const std::string &protocol) override
 
virtual TTV_ErrorCode CreateWebSocket (const std::string &uri, std::shared_ptr< IWebSocket > &result) override
 
GlobalJavaObjectReferenceGetJavaInstance ()
 

Protected Member Functions

TTV_ErrorCode CreateSocket (const std::string &uri, jobject &result)
 

Protected Attributes

GlobalJavaObjectReference mJavaInstance
 The java implementation of the factory. More...
 

Constructor & Destructor Documentation

◆ JavaWebSocketFactory()

ttv::binding::java::JavaWebSocketFactory::JavaWebSocketFactory ( JNIEnv *  jEnv,
jobject  jInstance 
)

◆ ~JavaWebSocketFactory()

virtual ttv::binding::java::JavaWebSocketFactory::~JavaWebSocketFactory ( )
virtual

Member Function Documentation

◆ CreateSocket()

TTV_ErrorCode ttv::binding::java::JavaSocketFactoryBase::CreateSocket ( const std::string &  uri,
jobject &  result 
)
protectedinherited

◆ CreateWebSocket()

virtual TTV_ErrorCode ttv::binding::java::JavaWebSocketFactory::CreateWebSocket ( const std::string &  uri,
std::shared_ptr< IWebSocket > &  result 
)
overridevirtual

Attempts to create an IWebSocket instance that supports the given URI.

See also
ttv::RegisterWebSocketFactory
Parameters
[in]uriThe full uri to create the socket for.
[out]resultThe 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.

◆ GetJavaInstance()

GlobalJavaObjectReference& ttv::binding::java::JavaSocketFactoryBase::GetJavaInstance ( )
inlineinherited

◆ IsProtocolSupported()

virtual bool ttv::binding::java::JavaWebSocketFactory::IsProtocolSupported ( const std::string &  protocol)
overridevirtual

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]protocolThe protocol to check support for.
Returns
true if the protocol is supported, false otherwise.

Implements ttv::IWebSocketFactory.

Member Data Documentation

◆ mJavaInstance

GlobalJavaObjectReference ttv::binding::java::JavaSocketFactoryBase::mJavaInstance
protectedinherited

The java implementation of the factory.


The documentation for this class was generated from the following file: