kanzi::connect::VirtualFileRemoteClient Class Reference

Remote access to VirtualFile service that resides in kanziconnect server. More...

#include <virtualfileremoteclient.hpp>

Inheritance diagram for kanzi::connect::VirtualFileRemoteClient:

Public Member Functions
string	getPath (RegistrationToken token) const
	Retrieve the path associated with the registration.
RegistrationToken	registerPath (const string &scheme, const string &path, VirtualFileProvider *provider)
	Registers a path to HTTP Server.
void	registerRegistrationStatusChangeCallback (RegistrationToken token, RegistrationStatusChangeCallback *callback)
	Register registration status change callback.
RegistrationStatus	registrationStatus (RegistrationToken token)
	Checks the registration status.
void	unregisterPath (RegistrationToken token)
	Unregisters previously registered path.
void	unregisterRegistrationStatusChangeCallback (RegistrationToken token)
	Clears previously registered status change callback.
Public Member Functions inherited from kanzi::connect::VirtualFileClient
virtual string	getIdentifier () const
	Returns the type of the service.
virtual	~VirtualFileClient ()
	C++ destructor - performs cleanup.
Public Member Functions inherited from kanzi::connect::AbstractServiceClient
	AbstractServiceClient ()
	Constructor.
AbstractSession::MessageSubscriptionToken	addMessageSubscription (const string &messageType, AbstractSession::MessageReceivedFunction function)
SessionRunningSubscriptionToken	addSessionRunningSubscription (SessionRunningFunction function)
SessionRunningSubscriptionToken	addSessionStoppedSubscription (SessionStoppedFunction function)
optional< int >	getActiveSessionIdentifier ()
optional< const AbstractSession::ServiceAttributes >	getServiceAttributes ()
virtual void	onSessionRunning ()
virtual void	onSessionStopped ()
void	removeMessageSubscription (const string &messageType, AbstractSession::MessageSubscriptionToken token)
void	removeSessionRunningSubscription (SessionRunningSubscriptionToken token)
void	removeSessionStoppedSubscription (SessionRunningSubscriptionToken token)
void	setEnabledState (bool newEnabledState)
	Enable/disable the service by allowing or blocking traffic between client and server.
bool	transmit (const MessagePackage &message)
virtual void	work ()
	Carry out asynchronous work bound to Kanzi Connect client main thread.
virtual	~AbstractServiceClient ()
	Destructor.

Static Public Member Functions
static VirtualFileRemoteClientSharedPtr	create (ClientSharedPtr client)
	Factory method to create object.
Static Public Member Functions inherited from kanzi::connect::VirtualFileClient
static string	Type ()
	Type of the client.

Protected Member Functions
void	onConnectionStateChanged (Connection::State state)
	Invoked when ever connection state changes.
	VirtualFileRemoteClient (ClientSharedPtr client)
	c++ constructor - initializes the object
Protected Member Functions inherited from kanzi::connect::AbstractServiceClient
virtual AbstractSessionSharedPtr	getSession ()

Additional Inherited Members
Public Types inherited from kanzi::connect::VirtualFileClient
enum	RegistrationStatus { NotRegistered , RegistrationInProgress , RegistrationFailed , Registered }
typedef enum kanzi::connect::VirtualFileClient::RegistrationStatus	RegistrationStatus
typedef shared_ptr< void >	RegistrationToken
	Token used to identify registration.
Public Types inherited from kanzi::connect::AbstractServiceClient
typedef function< void(void)>	SessionRunningFunction
typedef shared_ptr< void >	SessionRunningSubscriptionToken
typedef function< void(void)>	SessionStoppedFunction
Protected Types inherited from kanzi::connect::AbstractServiceClient
enum	SessionState { INITIALIZED = 0 , RUNNING = 1 , STOPPED = 2 }
Protected Attributes inherited from kanzi::connect::AbstractServiceClient
SessionState	m_sessionState

Detailed Description

Remote access to VirtualFile service that resides in kanziconnect server.

Constructor & Destructor Documentation

VirtualFileRemoteClient()

kanzi::connect::VirtualFileRemoteClient::VirtualFileRemoteClient ( ClientSharedPtr client )

protected

c++ constructor - initializes the object

Parameters

client

Member Function Documentation

create()

static VirtualFileRemoteClientSharedPtr kanzi::connect::VirtualFileRemoteClient::create ( ClientSharedPtr client )

static

Factory method to create object.

Parameters

client

pointer to client

Returns

newly allocated remote client instance.

getPath()

string kanzi::connect::VirtualFileRemoteClient::getPath ( RegistrationToken token ) const

virtual

Retrieve the path associated with the registration.

Parameters

token

The token that identifies the registration.

Returns

full path in form: http://<server>:8080/somepath/ empty string is returned if registration has failed, or it is still in progress.

Implements kanzi::connect::VirtualFileClient.

onConnectionStateChanged()

void kanzi::connect::VirtualFileRemoteClient::onConnectionStateChanged ( Connection::State state )

protected

Invoked when ever connection state changes.

Parameters

state

new state.

registerPath()

RegistrationToken kanzi::connect::VirtualFileRemoteClient::registerPath ( const string & scheme, const string & pathProposal, VirtualFileProvider * provider )

virtual

Registers a path to HTTP Server.

Registration is an asynchronous operation for remote clients.

Parameters

scheme	Requested protocol. Either HTTP or HTTPS expected. If you do not set a value, uses HTTP.
pathProposal	clients proposal of the path where the serving is to be done.
provider	pointer to callback interface that is, if successfully registered, invoked for every file request made under the registered path. Caller must guarantee that the provided callback interface remains valid until corresponding unregisterPath call is made.

Returns

Opaque token that identifies this registration.

Implements kanzi::connect::VirtualFileClient.

registerRegistrationStatusChangeCallback()

void kanzi::connect::VirtualFileRemoteClient::registerRegistrationStatusChangeCallback ( RegistrationToken token, RegistrationStatusChangeCallback * callback )

virtual

Register registration status change callback.

Registration is meaningful only for remote clients since status does not change for local clients.

Parameters

token	identification token.
callback	interface to be invoked when registration status changes.

Reimplemented from kanzi::connect::VirtualFileClient.

registrationStatus()

RegistrationStatus kanzi::connect::VirtualFileRemoteClient::registrationStatus ( RegistrationToken token )

virtual

Checks the registration status.

For remote operations registration is asynchronous and thus it is not complete until this method returns either Registered or RegistrationFailed. Also, if for example connection is lost, then the registration status changes even if it has been completed earlier.

Parameters

token

The token that identifies the registration.

Returns

enumerated status.

Implements kanzi::connect::VirtualFileClient.

unregisterPath()

void kanzi::connect::VirtualFileRemoteClient::unregisterPath ( RegistrationToken token )

virtual

Unregisters previously registered path.

Parameters

token

opaque handle got using the registerPath

Implements kanzi::connect::VirtualFileClient.

unregisterRegistrationStatusChangeCallback()

void kanzi::connect::VirtualFileRemoteClient::unregisterRegistrationStatusChangeCallback ( RegistrationToken token )

virtual

Clears previously registered status change callback.

Parameters

token

path registration token.

Reimplemented from kanzi::connect::VirtualFileClient.

---

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

• virtualfile_service/virtualfileremoteclient.hpp