Remote access to VirtualFile service that resides in kanziconnect server. More...
#include <virtualfileremoteclient.hpp>
Static Public Member Functions | |
static VirtualFileRemoteClientSharedPtr | create (ClientSharedPtr client) |
Factory method to create object. More... | |
Static Public Member Functions inherited from kanzi::connect::VirtualFileClient | |
static string | Type () |
Type of the client. More... | |
Protected Member Functions | |
void | onConnectionStateChanged (Connection::State state) |
Invoked when ever connection state changes. More... | |
VirtualFileRemoteClient (ClientSharedPtr client) | |
c++ constructor - initializes the object More... | |
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. More... | |
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 |
Remote access to VirtualFile service that resides in kanziconnect server.
|
protected |
c++ constructor - initializes the object
client |
|
static |
Factory method to create object.
client | pointer to client |
|
virtual |
Retrieve the path associated with the registration.
token | The token that identifies the registration. |
Implements kanzi::connect::VirtualFileClient.
|
protected |
Invoked when ever connection state changes.
state | new state. |
|
virtual |
Registers a path to HTTP Server.
Registration is an asynchronous operation for remote clients.
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. |
Implements kanzi::connect::VirtualFileClient.
|
virtual |
Register registration status change callback.
Registration is meaningful only for remote clients since status does not change for local clients.
token | identification token. |
callback | interface to be invoked when registration status changes. |
Reimplemented from kanzi::connect::VirtualFileClient.
|
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.
token | The token that identifies the registration. |
Implements kanzi::connect::VirtualFileClient.
|
virtual |
Unregisters previously registered path.
token | opaque handle got using the registerPath |
Implements kanzi::connect::VirtualFileClient.
|
virtual |
Clears previously registered status change callback.
token | path registration token. |
Reimplemented from kanzi::connect::VirtualFileClient.