webcom-base.h

Go to the documentation of this file.

/*
 * webcom-sdk-c
 *
 * Copyright 2018 Orange
 * <camille.oudot@orange.com>
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation; either version 2.1 of the License, or (at your
 * option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation,
 * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *
 */

#ifndef INCLUDE_WEBCOM_C_WEBCOM_BASE_H_
#define INCLUDE_WEBCOM_C_WEBCOM_BASE_H_


typedef struct wc_context wc_context_t;
typedef struct wc_datasync_context wc_datasync_context_t;
typedef struct wc_auth_context wc_auth_context_t;

#include <poll.h>
#include <stddef.h>
#include <stdint.h>

#define WC_POLLHUP (POLLHUP|POLLERR)
#define WC_POLLIN (POLLIN)
#define WC_POLLOUT (POLLOUT)

enum wc_pollsrc {
    WC_POLL_DATASYNC,           
    WC_POLL_AUTH,               

    _WC_POLL_MAX /* keep last */
};

enum wc_timersrc {
    WC_TIMER_DATASYNC_KEEPALIVE, 
    WC_TIMER_DATASYNC_RECONNECT, 
    WC_TIMER_AUTH,               

    _WC_TIMER_MAX /* keep last */
};

struct wc_pollargs {
    int fd;              
    short events;        
    enum wc_pollsrc src; 
};

struct wc_timerargs {
    long ms;                
    enum wc_timersrc timer; 
    int repeat;             
};

#define WC_BASE_EVENT_OFFSET        0x00000001
#define WC_DATASYNC_EVENT_OFFSET    0x00000100
#define WC_AUTH_EVENT_OFFSET        0x00010000

typedef enum {
    /* Base */

    WC_EVENT_ADD_FD = WC_BASE_EVENT_OFFSET,           

    WC_EVENT_DEL_FD,                                  

    WC_EVENT_MODIFY_FD,                               

    WC_EVENT_SET_TIMER,                               

    WC_EVENT_DEL_TIMER,                               

    /* Datasync */

    WC_EVENT_ON_CNX_CLOSED = WC_DATASYNC_EVENT_OFFSET,

    WC_EVENT_ON_SERVER_HANDSHAKE,                     

    WC_EVENT_ON_MSG_RECEIVED,                         

    WC_EVENT_ON_CNX_ERROR,                            

    /* Authentication */

    WC_AUTH_ON_AUTH_REPLY = WC_AUTH_EVENT_OFFSET,     
} wc_event_t;

typedef int (*wc_on_event_cb_t) (wc_event_t event, wc_context_t *ctx, void *data, size_t len);

struct wc_context_options {
    char *app_name;
    char *host;
    uint16_t port;
    wc_on_event_cb_t callback;
    int no_tls;
    void *user_data;
};

void wc_dispatch_fd_event(wc_context_t *ctx, struct wc_pollargs *pa);

void wc_dispatch_timer_event(wc_context_t *ctx, enum wc_timersrc timer);

void *wc_context_get_user_data(wc_context_t *ctx);


wc_context_t *wc_context_create(struct wc_context_options *options);

void wc_context_destroy(wc_context_t * ctx);

#endif /* INCLUDE_WEBCOM_C_WEBCOM_BASE_H_ */