VirtualFileRemoteClient

class kanzi::connect::VirtualFileRemoteClient : public VirtualFileClient

Remote access to VirtualFile service that resides in kanziconnect server.

Public Functions

virtual string getPath(RegistrationToken token) const

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.

virtual RegistrationToken registerPath(const string &scheme, const string &path, VirtualFileProvider *provider)

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.

virtual void registerRegistrationStatusChangeCallback(RegistrationToken token, RegistrationStatusChangeCallback *callback)

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.

virtual RegistrationStatus registrationStatus(RegistrationToken token)

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.

virtual void unregisterPath(RegistrationToken token)

Unregisters previously registered path.

Parameters

token – opaque handle got using the registerPath

virtual void unregisterRegistrationStatusChangeCallback(RegistrationToken token)

Clears previously registered status change callback.

Parameters

token – path registration token.

Public Static Functions

static VirtualFileRemoteClientSharedPtr create(ClientSharedPtr client)

Factory method to create object.

Parameters

client – pointer to client

Returns

newly allocated remote client instance.