websockets.h

Go to the documentation of this file.

 
#ifndef WEBSOCKETS_H
#define WEBSOCKETS_H
 
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
 
#include "logconf.h" /* struct logconf */
 
/* FORWARD DECLARATIONS */
struct websockets;
 
enum ws_status {
  WS_DISCONNECTED = 0, 
  WS_CONNECTED,        
  WS_DISCONNECTING,    
  WS_CONNECTING,       
};
 
enum ws_user_cmd {
  WS_USER_CMD_NONE,
  WS_USER_CMD_EXIT,
};
 
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, const char *protocols);
  void (*on_text)(void *data, const char *text, size_t len);
  void (*on_binary)(void *data, const void *mem, size_t len);
  void (*on_ping)(void *data, const char *reason, size_t len);
  void (*on_pong)(void *data, const char *reason, size_t len);
  void (*on_close)(void *data, enum ws_close_reason wscode, const char *reason, size_t len);
  void *data;
};
 
struct websockets* ws_init(struct ws_callbacks *cbs, struct logconf *config);
 
void ws_cleanup(struct websockets *ws);
 
void ws_set_url(struct websockets *ws, const char base_url[], const char ws_protocols[]);
 
bool ws_send_text(struct websockets *ws, char text[], size_t len);
 
void ws_start(struct websockets *ws);
 
void ws_perform(struct websockets *ws, _Bool *is_running, uint64_t wait_ms);
 
uint64_t ws_timestamp(struct websockets *ws);
 
enum ws_status ws_get_status(struct websockets *ws);
 
char* ws_close_opcode_print(enum ws_close_reason opcode);
 
bool ws_is_alive(struct websockets *ws);
 
bool ws_is_functional(struct websockets *ws);
 
void ws_exit_event_loop(struct websockets *ws);
 
bool ws_same_thread(struct websockets *ws);
 
#ifdef __cplusplus
}
#endif // __cplusplus
 
#endif // WEBSOCKETS_H