curl-websocket.h

Go to the documentation of this file.

/*
 * Copyright (C) 2016 Gustavo Sverzut Barbieri
 *
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use, copy,
 * modify, merge, publish, distribute, sublicense, and/or sell copies
 * of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
/* c-mode: linux-4 */
 
#ifndef _CURL_WEBSOCKET_H_
#define _CURL_WEBSOCKET_H_ 1
 
#include <curl/curl.h>
#include <string.h>
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* see https://tools.ietf.org/html/rfc6455#section-7.4.1 */
enum cws_close_reason {
    CWS_CLOSE_REASON_NORMAL               = 1000,
    CWS_CLOSE_REASON_GOING_AWAY           = 1001,
    CWS_CLOSE_REASON_PROTOCOL_ERROR       = 1002,
    CWS_CLOSE_REASON_UNEXPECTED_DATA      = 1003,
    CWS_CLOSE_REASON_NO_REASON            = 1005,
    CWS_CLOSE_REASON_ABRUPTLY             = 1006,
    CWS_CLOSE_REASON_INCONSISTENT_DATA    = 1007,
    CWS_CLOSE_REASON_POLICY_VIOLATION     = 1008,
    CWS_CLOSE_REASON_TOO_BIG              = 1009,
    CWS_CLOSE_REASON_MISSING_EXTENSION    = 1010,
    CWS_CLOSE_REASON_SERVER_ERROR         = 1011,
    CWS_CLOSE_REASON_IANA_REGISTRY_START  = 3000,
    CWS_CLOSE_REASON_IANA_REGISTRY_END    = 3999,
    CWS_CLOSE_REASON_PRIVATE_START        = 4000,
    CWS_CLOSE_REASON_PRIVATE_END          = 4999
};
 
struct cws_callbacks {
    void (*on_connect)(void *data, CURL *easy, const char *websocket_protocols);
    void (*on_text)(void *data, CURL *easy, const char *text, size_t len);
    void (*on_binary)(void *data, CURL *easy, const void *mem, size_t len);
    void (*on_ping)(void *data, CURL *easy, const char *reason, size_t len);
    void (*on_pong)(void *data, CURL *easy, const char *reason, size_t len);
    void (*on_close)(void *data, CURL *easy, enum cws_close_reason reason, const char *reason_text, size_t reason_text_len);
    const void *data;
};
 
CURL *cws_new(const char *url, const char *websocket_protocols, const struct cws_callbacks *callbacks);
 
void cws_free(CURL *easy);
 
bool cws_send(CURL *easy, bool text, const void *msg, size_t msglen);
 
static inline bool cws_send_binary(CURL *easy, const void *msg, size_t msglen) {
    return cws_send(easy, false, msg, msglen);
}
 
static inline bool cws_send_text(CURL *easy, const char *string) {
    return cws_send(easy, true, string, strlen(string));
}
 
bool cws_ping(CURL *easy, const char *reason, size_t len);
 
bool cws_pong(CURL *easy, const char *reason, size_t len);
 
bool cws_close(CURL *easy, enum cws_close_reason reason, const char *reason_text, size_t reason_text_len);
 
void cws_add_header(CURL *easy, const char field[],  const char value[]);
 
#ifdef __cplusplus
}
#endif
 
#endif