#include <externalclientadapter.hpp>
Public Member Functions | |
void | addInterface () |
Second phase of initialization forced by shared_from_this. Add interface to the client. More... | |
ExternalClientInterface (Client &client, const string &identifier) | |
Constructor. More... | |
void | onReleaseSession (AbstractSessionSharedPtr session) |
Function that allows derived classes to destroy their type-specific session instance. More... | |
~ExternalClientInterface () | |
Destructor Removes interface from the client. More... | |
Public Member Functions inherited from kanzi::connect::InterfaceClient< InterfaceObserver, ExternalClientSession > | |
AbstractSessionSharedPtr | acquireSession (MessageDispatcher *dispatcher) |
Acquire session in to this interface. More... | |
void | addObserver (AbstractSessionSharedPtr session, InterfaceObserver *observer) |
Add observer in to this interface for given session. More... | |
RPCCallStore & | getCallStore () |
Retrieve RPC call store that is used to manage pending RPC calls. More... | |
virtual string | getIdentifier () const |
Returns the type id of the interface. More... | |
InterfaceObserver * | getObserver (AbstractSessionSharedPtr session) |
Retrieve observer for given session. More... | |
InterfaceClient (const string &identifier, RPCCallStore &callstore) | |
virtual AbstractSessionSharedPtr | onAcquireSession (int sessionId, MessageDispatcher *dispatcher) |
Function that allows derived classes to create their type-specific session instance. More... | |
virtual void | receive (const MessagePackage &message) |
Pass a message package to this interface, resolves proper session and makes it receive the package. More... | |
void | releaseSession (AbstractSessionSharedPtr session) |
Release session that is connected to this interface. More... | |
void | removeObserver (AbstractSessionSharedPtr session) |
Remove observer from a given session. More... | |
Public Member Functions inherited from kanzi::connect::AbstractInterfaceClient | |
AbstractInterfaceClient (RPCCallStore &callStore) | |
Constructor. More... | |
AbstractSessionSharedPtr | acquireAbstractSession (MessageDispatcher *dispatcher) |
Acquires a session for this interface. More... | |
shared_ptr< p2p::RoutingRules > | getRoutingRules () |
Retrieve routing rules for this particular client. More... | |
AbstractSessionSharedPtr | getSession (int sessionId) |
Returns session by id. More... | |
bool | isSessionRunning (AbstractSessionSharedPtr session) const |
Check if the given session is running or not. More... | |
void | notifyServiceReachable (bool reachable) |
Invoked to notify clients whether specific service is reachable or not. More... | |
virtual void | registerRemoteInterface (MessageTranslator *translator) |
Registers this interface to given message translator. More... | |
void | releaseAbstractSession (AbstractSessionSharedPtr session) |
Releases given session from this interface. More... | |
bool | serviceReachable () const |
Is service currently known to be reachable. More... | |
void | setClient (ClientSharedPtr client) |
Stores the client this interface is bound to. More... | |
void | setServiceReachableCallback (ServiceReachableCallback callback) |
Registers service reachable callback. More... | |
void | setSessionRunning (AbstractSessionSharedPtr session) |
Set the given session to running state. More... | |
void | setSessionStopped (AbstractSessionSharedPtr session) |
Set the given session to stopped state. More... | |
void | stopAllSessions () |
Ends all sessions since maybe the service itself has disappeared. More... | |
void | terminateAllSessions () |
Terminates all ongoing sessions. More... | |
virtual | ~AbstractInterfaceClient () |
Destructor. More... | |
Additional Inherited Members | |
Public Types inherited from kanzi::connect::InterfaceClient< InterfaceObserver, ExternalClientSession > | |
typedef map< AbstractSessionSharedPtr, InterfaceObserver *> | ObserverContainer |
Type definition for observer container. More... | |
Public Types inherited from kanzi::connect::AbstractInterfaceClient | |
typedef function< void(bool)> | ServiceReachableCallback |
Callback to inform whether service at server is available or not. More... | |
Protected Attributes inherited from kanzi::connect::InterfaceClient< InterfaceObserver, ExternalClientSession > | |
string | m_identifier |
Protected Attributes inherited from kanzi::connect::AbstractInterfaceClient | |
RPCCallStore & | m_callStore |
kanzi::connect::ExternalClientInterface::ExternalClientInterface | ( | Client & | client, |
const string & | identifier | ||
) |
Constructor.
client | the client this interface is bound to |
identifier | the identifier of the service this generic client interface is bound to. |
kanzi::connect::ExternalClientInterface::~ExternalClientInterface | ( | ) |
Destructor Removes interface from the client.
void kanzi::connect::ExternalClientInterface::addInterface | ( | ) |
Second phase of initialization forced by shared_from_this. Add interface to the client.
|
virtual |
Function that allows derived classes to destroy their type-specific session instance.
session | Session to release. |
Reimplemented from kanzi::connect::AbstractInterfaceClient.