websockets.h

Go to the documentation of this file.

 
#ifndef WEBSOCKETS_H
#define WEBSOCKETS_H
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
#include <curl/curl.h>
 
#include "error.h" /* CCORDcode */
#include "logconf.h" /* logging facilities */
 
struct websockets;
 
struct ws_info {
    struct loginfo loginfo;
    CCORDcode code;
};
 
enum ws_status {
    WS_DISCONNECTED = 0,
    WS_CONNECTED,
    WS_DISCONNECTING,
    WS_CONNECTING,
};
 
enum ws_close_reason {
    WS_CLOSE_REASON_NORMAL = 1000,
    WS_CLOSE_REASON_GOING_AWAY = 1001,
    WS_CLOSE_REASON_PROTOCOL_ERROR = 1002,
    WS_CLOSE_REASON_UNEXPECTED_DATA = 1003,
    WS_CLOSE_REASON_NO_REASON = 1005,
    WS_CLOSE_REASON_ABRUPTLY = 1006,
    WS_CLOSE_REASON_INCONSISTENT_DATA = 1007,
    WS_CLOSE_REASON_POLICY_VIOLATION = 1008,
    WS_CLOSE_REASON_TOO_BIG = 1009,
    WS_CLOSE_REASON_MISSING_EXTENSION = 1010,
    WS_CLOSE_REASON_SERVER_ERROR = 1011,
    WS_CLOSE_REASON_IANA_REGISTRY_START = 3000,
    WS_CLOSE_REASON_IANA_REGISTRY_END = 3999,
    WS_CLOSE_REASON_PRIVATE_START = 4000,
    WS_CLOSE_REASON_PRIVATE_END = 4999
};
 
struct ws_callbacks {
    void (*on_connect)(void *data,
                       struct websockets *ws,
                       struct ws_info *info,
                       const char *protocols);
 
    void (*on_text)(void *data,
                    struct websockets *ws,
                    struct ws_info *info,
                    const char *text,
                    size_t len);
 
    void (*on_binary)(void *data,
                      struct websockets *ws,
                      struct ws_info *info,
                      const void *mem,
                      size_t len);
    void (*on_ping)(void *data,
                    struct websockets *ws,
                    struct ws_info *info,
                    const char *reason,
                    size_t len);
 
    void (*on_pong)(void *data,
                    struct websockets *ws,
                    struct ws_info *info,
                    const char *reason,
                    size_t len);
 
    void (*on_close)(void *data,
                     struct websockets *ws,
                     struct ws_info *info,
                     enum ws_close_reason wscode,
                     const char *reason,
                     size_t len);
 
    void *data;
};
 
struct ws_attr {
    struct logconf *conf;
};
 
#define ws_is_alive(ws) (ws_get_status(ws) != WS_DISCONNECTED)
 
#define ws_is_functional(ws) (ws_get_status(ws) == WS_CONNECTED)
 
struct websockets *ws_init(struct ws_callbacks *cbs,
                           CURLM *mhandle,
                           struct ws_attr *attr);
 
void ws_cleanup(struct websockets *ws);
 
void ws_set_url(struct websockets *ws,
                const char base_url[],
                const char ws_protocols[]);
 
_Bool ws_send_binary(struct websockets *ws,
                     struct ws_info *info,
                     const char msg[],
                     size_t msglen);
_Bool ws_send_text(struct websockets *ws,
                   struct ws_info *info,
                   const char text[],
                   size_t len);
_Bool ws_ping(struct websockets *ws,
              struct ws_info *info,
              const char reason[],
              size_t len);
_Bool ws_pong(struct websockets *ws,
              struct ws_info *info,
              const char reason[],
              size_t len);
 
CURL* ws_start(struct websockets *ws);
 
void ws_end(struct websockets *ws);
 
_Bool ws_easy_run(struct websockets *ws, uint64_t wait_ms, uint64_t *tstamp);
 
_Bool ws_multi_socket_run(struct websockets *ws, uint64_t *tstamp);
 
enum ws_status ws_get_status(struct websockets *ws);
 
const char *ws_close_opcode_print(enum ws_close_reason opcode);
 
uint64_t ws_timestamp(struct websockets *ws);
 
uint64_t ws_timestamp_update(struct websockets *ws);
 
void ws_close(struct websockets *ws,
              const enum ws_close_reason code,
              const char reason[],
              const size_t len);
 
void ws_add_header(struct websockets *ws,
                   const char field[],
                   const char value[]);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* WEBSOCKETS_H */