Kanzi Connect 3.9.10
kanzi::connect::ClientStreamSession Class Reference

#include <stream_session_client.hpp>

Inheritance diagram for kanzi::connect::ClientStreamSession:
kanzi::connect::AbstractSession

Public Member Functions

 ClientStreamSession (RPCCallStore &registry, int clientId, int sessionId, MessageDispatcher *dispatcher, const kanzi::string &instanceName)
 
virtual kanzi::shared_ptr< GenericRPCReplyMessage > onReceiveMessage (const MessagePackage &message) override
 Allows derived class to receive notification of received message.
 
void removeSubscription (const kanzi::string &streamId)
 
void requestEncoderParameter (const kanzi::string &streamId, const kanzi::string &parameterName)
 
void requestStreamInfo (const kanzi::string &streamId)
 
void restartEncoder (const kanzi::string &streamId)
 
void setEncoderParameter (const kanzi::string &streamId, const kanzi::string &parameterName, const kanzi::string &parameterValue)
 
void setInterface (StreamInterfaceClient *interfaceClass)
 
void setStreamContent (const kanzi::string &streamId, const kanzi::string &contentDescription)
 
kanzi::connect::RPCResult< bool > subscribeBlobs (const kanzi::string &streamId)
 
- Public Member Functions inherited from kanzi::connect::AbstractSession
 AbstractSession (const string &interfaceId, int clientId, int sessionId, MessageDispatcher *dispatcher)
 Constructor.
 
MessageSubscriptionToken addMessageSubscription (const string &messageType, MessageReceivedFunction function)
 Subscribe all messages of type.
 
MessageSubscriptionToken addMessageTypeSubscription (int messageType, MessageReceivedFunction function)
 Subscribe all messages of Message Package type.
 
MessageSubscriptionToken addRegexMessageSubscription (const string &regex, MessageReceivedFunction function)
 Subscribe all messages that match a regular expression.
 
void changeMessageDispatcher (MessageDispatcher *dispatcher)
 Changes message dispatcher on the fly.
 
void enableVerboseLogging (bool enable)
 Enables verbose logging for the functionality.
 
ClientDescriptorSharedPtr getClientDescriptor () const
 Retrieve client descriptor.
 
int getClientId () const
 Retrieve client id of the session.
 
int getId () const
 Retrieve id of the session.
 
const string & getInterfaceId () const
 Retrieve id of the interface.
 
int getServerClientId () const
 Retrieve server client identifier of the session.
 
const ServiceAttributesgetServiceAttributes ()
 
virtual void initialize ()
 Initializes this session.
 
void receive (const MessagePackage &message)
 Asks session to process received message.
 
void removeMessageSubscription (const string &messageType, MessageSubscriptionToken token)
 Remove message subscription.
 
void removeMessageTypeSubscription (int messageType, MessageSubscriptionToken token)
 Remove message subscription.
 
void removeRegexMessageSubscription (const string &regex, MessageSubscriptionToken token)
 Remove regular expression message subscription.
 
void setClientDescriptor (ClientDescriptorSharedPtr clientDescriptor)
 Saves a client descriptor of the client who created this session.
 
void setClientP2PRoutingInstructions (shared_ptr< p2p::P2PClient::RoutingHandler > routingHandler)
 Configure P2P routing instructions for the client.
 
void setGenericInvoker (GenericInvoker *invoker)
 Setups generic invocation mechanism.
 
void setServerClientId (int id)
 Sets servers identifier of the client this session belongs to.
 
void setServerP2PRouter (p2p::P2PServerSharedPtr serverRouter)
 Configure P2P routing for server scope.
 
void terminate ()
 Terminates the session.
 
bool transmit (const MessagePackage &message)
 Sends outgoing message to network.
 
bool transmit (MessagePackageSharedPtr message, uint32_t call_handle=0)
 Sends outgoing message to network.
 
virtual void uninitialize ()
 Un-initializes this session.
 
void updateEnabledState (bool newEnabledState)
 Update the enabled state of this session.
 
virtual ~AbstractSession ()
 Destructor.
 

Protected Attributes

RPCCallStorem_callRegistry
 
StreamInterfaceClientm_interface
 

Additional Inherited Members

- Public Types inherited from kanzi::connect::AbstractSession
typedef function< bool(const MessagePackage &message) MessageReceivedFunction)
 Message subscription callback.
 
typedef shared_ptr< void > MessageSubscriptionToken
 
typedef unordered_map< string, string > ServiceAttributes
 
- Protected Member Functions inherited from kanzi::connect::AbstractSession
virtual void onTransmitMessage (const MessagePackage &message)
 Allows derived class to receive notification of transmitted message.
 

Constructor & Destructor Documentation

◆ ClientStreamSession()

kanzi::connect::ClientStreamSession::ClientStreamSession ( RPCCallStore & registry,
int clientId,
int sessionId,
MessageDispatcher * dispatcher,
const kanzi::string & instanceName )

Member Function Documentation

◆ onReceiveMessage()

virtual kanzi::shared_ptr< GenericRPCReplyMessage > kanzi::connect::ClientStreamSession::onReceiveMessage ( const MessagePackage & message)
overridevirtual

Allows derived class to receive notification of received message.

Parameters
messageMessage that was received.

Reimplemented from kanzi::connect::AbstractSession.

◆ removeSubscription()

void kanzi::connect::ClientStreamSession::removeSubscription ( const kanzi::string & streamId)

◆ requestEncoderParameter()

void kanzi::connect::ClientStreamSession::requestEncoderParameter ( const kanzi::string & streamId,
const kanzi::string & parameterName )

◆ requestStreamInfo()

void kanzi::connect::ClientStreamSession::requestStreamInfo ( const kanzi::string & streamId)

◆ restartEncoder()

void kanzi::connect::ClientStreamSession::restartEncoder ( const kanzi::string & streamId)

◆ setEncoderParameter()

void kanzi::connect::ClientStreamSession::setEncoderParameter ( const kanzi::string & streamId,
const kanzi::string & parameterName,
const kanzi::string & parameterValue )

◆ setInterface()

void kanzi::connect::ClientStreamSession::setInterface ( StreamInterfaceClient * interfaceClass)
inline

◆ setStreamContent()

void kanzi::connect::ClientStreamSession::setStreamContent ( const kanzi::string & streamId,
const kanzi::string & contentDescription )

◆ subscribeBlobs()

kanzi::connect::RPCResult< bool > kanzi::connect::ClientStreamSession::subscribeBlobs ( const kanzi::string & streamId)

Member Data Documentation

◆ m_callRegistry

RPCCallStore& kanzi::connect::ClientStreamSession::m_callRegistry
protected

◆ m_interface

StreamInterfaceClient* kanzi::connect::ClientStreamSession::m_interface
protected

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