Framework for JSON APIs on websocket connections

AppWebsocket connections use JSON messages for communication. Those messages are normaly received and processed by the application. But sometimes it is wanted to build modules for re-occurring communication types that can be reused. This can be done using JSON APIs. The idea is that many JSON APIs can be attached to a single AppWebsocket connection and each of them processes the JSON messages with a specific "api" attribute.

This framework provides base classes and interfaces that are needed to implement JSON APIs and attach them to a connection.

File information

Filecommon/interface/json_api.h

Classes JsonApiContext
UJsonApiContext
JsonApi
IJsonApiConnection

Classes

JsonApiContext

class JsonApiContext {
public:
    JsonApiContext() {
        providers = 0;
    }
    void RegisterJsonApi(class UJsonApiContext * provider) {
        provider->next = providers;
        providers = provider;
    }
    class JsonApi * CreateJsonApi(const char * name, class IJsonApiConnection * connection, class json_io & msg, word base) {
        for (class UJsonApiContext * p = providers; p; p = p->next) {
            if (!strcmp(name, p->Name())) return p->CreateJsonApi(connection, msg, base);
        }
        return 0;
    }
    class JsonApi * JsonApiRequested(const char * name, class IJsonApiConnection * connection) {
        for (class UJsonApiContext * p = providers; p; p = p->next) {
            if (!strcmp(name, p->Name())) return p->JsonApiRequested(connection);
        }
        return 0;
    }
    class UJsonApiContext * providers;
};

Overview

The class JsonApiContext must be used as base class by an object using other Json Api implementations. Typically the instance class of an app uses this class as base class. This class is passed as argument on the constructor of AppWebsocket so that for incoming messages an api implementation can be found.

Public functions

RegisterJsonApi
This function is called for each api implementaion which shall be used. The api implementation is added to the list of "providers"
CreateJsonApi
This function is used to add actively an AppWebsocketSession to an api implementation, when the app has determined that a given cooonection can be used for the api. For example if a connection is incoming from a PBX this connection can be used for the replicator to replicate a user table, so CreateJsonApi is called.
JsonApiRequested
This function is called by AppWebsocket if a message is received addressing a new api. The list of providers is searched for a matching provider and if found the JsonApiRequested function of the provider is called.

UJsonApiContext

class UJsonApiContext {
public:
    virtual class JsonApi * CreateJsonApi(class IJsonApiConnection * connection, class json_io & msg, word base) = 0;
    virtual class JsonApi * JsonApiRequested(class IJsonApiConnection * connection) { return 0; };
    virtual const char * Name() = 0;
    class UJsonApiContext * next;
};

Overview

This class is used as base class by an api implementation. With this class the api is added to the list of providers for a given JsonApiContext.

Public functions

CreateJsonApi
Called to add a AppWebsocketConnection to the Api implementation. The message used to decide if the AppWebsocket can be used by the api implementation is passed as json_io object.
JsonApiRequested
Called if a message with an api matching the name of this provider was received, for which no JsonApi existed, so that the api provider can create a JsonApi object.

JsonApi

class JsonApi {
public:
    virtual ~JsonApi() {};
    virtual const char * Name() = 0;
    virtual void JsonApiStart() {};
    virtual void Message(class json_io & msg, word base, const char * mt, const char * src) = 0;
    virtual void JsonApiConnectionClosed() = 0;
};

Overview

This is the base class for JSON APIs. One instance can be attached to one connection. So for each connection the application has to create a new JsonApi instance.

Public functions

Name

Return value

The name of the API, e.g. "com.innovaphone.provisioning".
JsonApiStart
Can be called by the application to start the API. This is needed when the local API object needs to send an initial message before any other API messages are received.
Message
Processes an incoming message. This function is called by the associated IJsonApiConnection.

Parameters

class json_io & msg The JSON structure containing the message.
const char * mt The message type of the message.
const char * src The src is used for multiplexing on the remote side. If specified, all answers to this message should contain the same src value.
JsonApiConnectionClosed
Called by the associated IJsonApiConnection if the connection was closed. Implementation must not do any more function calls to the IJsonApiConnection and shutdown (delete) themselves.

IJsonApiConnection

class IJsonApiConnection {
public:
    virtual ~IJsonApiConnection() {}
    virtual void RegisterJsonApi(class JsonApi * api) = 0;
    virtual void UnRegisterJsonApi(class JsonApi * api) = 0;
    virtual void JsonApiMessage(class json_io & msg, char * buffer) = 0;
    virtual void JsonApiMessageComplete() = 0;
    virtual bool JsonApiPermission(const char * api) = 0;
};

Overview

This interface represents a websocket connection that supports plugging-in JsonApi instances. A well-known implementation of the interface is AppWebsocket.

Public functions

RegisterJsonApi
Attaches a JsonApi object to the connection. The object will start receiving the incoming websocket messages with the "api" attibute specified by the object.

Parameters

class JsonApi * api The JsonApi object that shall be attached.
UnRegisterJsonApi
Removes a JsonApi object from the connection. The object will stop receiving messages.

Parameters

class JsonApi * api The JsonApi object that shall be removed.
JsonApiMessage
To be called by JsonApi objects to send a message over the connection.

Parameters

class json_io & msg A JSON structure containing the message.
char * buffer A buffer that is big enough to contain the whole encoded message including NULL termination.
JsonApiMessageComplete
To be called by JsonApi objects if they have finished processing the last Message callback and are ready to receive the next message.
JsonApiPermission
This function is used internally to check if access to a certain API shall be granted.

Parameters

const char * api The name of the API.

Return value

true if access to the API is granted, false otherwise.