AppWebsocket

The appwebsocket library contains a class AppWebsocket, which can be used as base class for a session object allocated for incoming websocket connections. This class handles the authentication protocol using the myPBX authentication. It relates to the innovaphone.appwebsocket.js library on the client side. There are member functions for sending and receiving messages.

Protocol

JSON messages are used on this interface. There are some common properties, which are defined by the this library already, which is documented as AppWebsocket

APIs

The library uses the mechanism defined by json_api.h to plug-in code to implement a specific API, which is addressed by the "api" property. Any App may use or provide APIs. These are documented in the context of these Apps. There are also libraries using this API mechanism (e.g. Replication).

File information

Classes

class AppWebsocket : public UWebsocket, public IJsonApiConnection {

    ...

public:
    AppWebsocket(IWebserverPlugin * plugin, class IInstanceLog * const log, class JsonApiContext * jsonApiContext = 0);
    ~AppWebsocket();

    virtual char * AppWebsocketPassword() { return 0; };
    virtual char * AppWebsocketPassword(const char * domain) { return NULL; };
    virtual const char * AppWebsocketInstanceDomain() { return NULL; };
    virtual void AppWebsocketMessage(class json_io & msg, word base, const char * mt, const char * src) = 0;
    virtual void AppWebsocketBinaryMessage(void * buffer, int len) { };
    virtual void AppWebsocketAppInfo(const char * app, class json_io & msg, word base) { }
    virtual void AppWebsocketServiceInfo(const char * app, class json_io & msg, word base) { }
    virtual const char * AppWebsocketDeviceAppType(const char * app) { return 0; }
    virtual void AppWebsocketLogin(class json_io & msg, word info) { };
    virtual bool AppWebsocketConnectComplete(class json_io & msg, word info) { return true; }
    virtual void AppWebsocketClosed() = 0;
    virtual bool AppWebsocketApiPermission(const char * api) { return true; }
    virtual void AppWebsocketSendResult() = 0;
    virtual void AppWebsocketCheckLogin(const char * src, const char * app, const char * domain, const char * challenge, const char * digest) { AppWebsocketCheckLoginComplete(src, app, domain, challenge, digest, AppWebsocketPassword()); };

    bool AppWebsocketLoginComplete(const char * password, char * key = 0, unsigned keyLen = 0);
    void AppWebsocketCheckLoginComplete(const char * src, const char * app, const char * domain, const char * challenge, const char * digest, const char * password);
    void AppWebsocketMessageComplete();
    void AppWebsocketMessageSend(class json_io & msg, char * buffer);
    void AppWebsocketMessageSendText(const char * buffer);
    void AppWebsocketMessageSendBinary(char * buffer, int len);
    void AppWebsocketClose();

    void AppWebsocketEncrypt(const char * seed, const char * data, char * out, size_t outLen);
    void AppWebsocketDecrypt(const char * seed, const char * data, char * out, size_t outLen);
    void AppWebsocketHash(const char * seed, const char * data, char * out, size_t outLen);

    bool AppWebsocketIsEncryptedConnection() { return websocket->IsEncryptedConnection(); };

    void RegisterJsonApi(class JsonApi * api) override;
    void UnRegisterJsonApi(class JsonApi * api) override;
    void JsonApiMessage(class json_io & msg, char * buffer, class JsonApi * response = 0) override;
    void JsonApiMessageText(const char * buffer, class JsonApi * response = 0) override;
    void JsonApiMessageComplete() override;
    bool JsonApiPermission(const char * api) override { return AppWebsocketApiPermission(api); };

    char * domain;
    char * sip;
    char * guid;
    char * dn;
    char * app;
    char key[65];
};

Base class for incoming AppWebsocket sessions. It provides public functions which may be called by the application and virtual function, which may be overridden for the signaling of events on the protocol.

Code Examples

Publishing app information

void MySession::AppWebsocketAppInfo(const char * app, class json_io & msg, word base)
{
    if (!strcmp(app, "my-searchprovider")) {
        // general app info
        msg.add_bool(base, "hidden", true); // app is hidden
        msg.add_bool(base, "presence", true); // app provides presence (badge counts)
        
        // apis
        word apis = msg.add_object(base, "apis");
        word search = msg.add_object(apis, "com.innovaphone.search");
        word info = msg.add_object(search, "info");
        msg.add_string(info, "someattr", "somevalue");
    }
}

Publishing service information

void MySession::AppWebsocketServiceInfo(const char * app, class json_io & msg, word base)
{
    if (!strcmp(app, "my-channels-service")) {
        word apis = msg.add_object(base, "apis");
        msg.add_object(apis, "com.innovaphone.channels");
    }
}