client.h

Go to the documentation of this file.

#ifndef JABBERWERX_CLIENT_H
#define JABBERWERX_CLIENT_H

#include "jid.h"
#include "tracker.h"
#include "stream.h"
#include "util/workq.h"


#define JW_CLIENT_CONFIG_USERJID "userjid"

#define JW_CLIENT_CONFIG_USERPW "userpassword"

#define JW_CLIENT_CONFIG_STREAM_TYPE "streamtype"

#define JW_CLIENT_CONFIG_JID_CONTEXT "jidcontext"

#define JW_CLIENT_CONFIG_SM_ENABLED "sm_enabled"

#define JW_CLIENT_CONFIG_SM_RESUME_ENABLED "sm_resume_enabled"

#define JW_CLIENT_CONFIG_SM_RESUME_TIMEOUT_SECONDS "sm_resume_timeout"

#define JW_CLIENT_CONFIG_SM_ACK_REQUEST_THRESHOLD "sm_ack_request_threshold"

#define JW_CLIENT_CONFIG_SM_ACK_REQUEST_THRESHOLD_SECONDS \
        "sm_ack_request_threshold_seconds"

#define JW_CLIENT_CONFIG_RECONNECT_BASE_COUNTDOWN "client_reconnect_countdown"

#define JW_CLIENT_CONFIG_SASL_FACTORY "client_sasl_factory"

#define JW_CLIENT_CONFIG_STREAM_TYPE_SOCKET "socket"

#define JW_CLIENT_CONFIG_STREAM_TYPE_BOSH "bosh"

#define JW_CLIENT_EVENT_STATUSCHANGED "clientStatusChanged"

#define JW_CLIENT_EVENT_CONNECTED "clientConnected"

#define JW_CLIENT_EVENT_DISCONNECTED "clientDisconnected"

#define JW_CLIENT_EVENT_SESSION_PAUSED "clientSessionPaused"

#define JW_CLIENT_EVENT_SESSION_RESUMED "clientSessionResumed"

#define JW_CLIENT_EVENT_DESTROYED "clientDestroyed"

#define JW_CLIENT_EVENT_BEFORE_IQ_RECEIVED "beforeIqReceived"

#define JW_CLIENT_EVENT_IQ_RECEIVED "iqReceived"

#define JW_CLIENT_EVENT_AFTER_IQ_RECEIVED "afterIqReceived"

#define JW_CLIENT_EVENT_BEFORE_IQ_SENT "beforeIqSent"

#define JW_CLIENT_EVENT_IQ_SENT "iqSent"

#define JW_CLIENT_EVENT_BEFORE_PRESENCE_RECEIVED "beforePresenceReceived"

#define JW_CLIENT_EVENT_PRESENCE_RECEIVED "presenceReceived"

#define JW_CLIENT_EVENT_AFTER_PRESENCE_RECEIVED "afterPresenceReceived"

#define JW_CLIENT_EVENT_BEFORE_PRESENCE_SENT "beforePresenceSent"

#define JW_CLIENT_EVENT_PRESENCE_SENT "presenceSent"

#define JW_CLIENT_EVENT_BEFORE_MESSAGE_RECEIVED "beforeMessageReceived"

#define JW_CLIENT_EVENT_MESSAGE_RECEIVED "messageReceived"

#define JW_CLIENT_EVENT_AFTER_MESSAGE_RECEIVED "afterMessageReceived"

#define JW_CLIENT_EVENT_BEFORE_MESSAGE_SENT "beforeMessageSent"

#define JW_CLIENT_EVENT_MESSAGE_SENT "messageSent"

#define JW_CLIENT_EVENT_RECONNECT_STATUSCHANGED "reconnectStatusChanged"


typedef enum
{
    JW_CLIENT_DISCONNECTED = 0,
    JW_CLIENT_CONNECTING,
    JW_CLIENT_CONNECTED,
    JW_CLIENT_DISCONNECTING
} jw_client_statustype;

typedef enum
{
    JW_CLIENT_RECONNECT_CANCELED = 0, // reconnect can not occur
    JW_CLIENT_RECONNECT_PENDING,      // reconnect attempt when possible
    JW_CLIENT_RECONNECT_STARTING      // connection is being attempted
} jw_client_reconnect_statustype;


typedef struct _jw_client jw_client;

typedef struct _jw_client_status jw_client_status;

typedef struct _jw_client_reconnect_status jw_client_reconnect_status;


#ifdef __cplusplus
extern "C"
{
#endif

JABBERWERX_API bool jw_client_create(jw_workq   *workq,
                                     jw_client **client,
                                     jw_err    *err);

JABBERWERX_API void jw_client_destroy(jw_client *client);

JABBERWERX_API bool jw_client_connect(jw_client *client,
                                      jw_htable *config,
                                      jw_err    *err);

JABBERWERX_API void jw_client_disconnect(jw_client *client,
                                         jw_errcode disconnect_reason);

JABBERWERX_API jw_workq* jw_client_get_workq(jw_client *client);

JABBERWERX_API struct event_base* jw_client_get_selector(jw_client *client);

JABBERWERX_API jw_client_statustype jw_client_get_status(jw_client *client);

JABBERWERX_API jw_htable *jw_client_get_config(jw_client *client);

JABBERWERX_API jw_jid *jw_client_get_jid(jw_client *client);

JABBERWERX_API bool jw_client_is_connected(jw_client *client);

JABBERWERX_API bool jw_client_is_reconnect_pending(jw_client *client);

JABBERWERX_API jw_event *jw_client_event(jw_client *client,
                                        const char *name);

JABBERWERX_API jw_client_statustype jw_client_status_get_previous(
                                                    jw_client_status *status);

JABBERWERX_API jw_client_statustype jw_client_status_get_next(
                                                    jw_client_status *status);

JABBERWERX_API jw_dom_node *jw_client_status_get_error(
                                                    jw_client_status *status);

JABBERWERX_API bool jw_client_status_is_reconnect(jw_client_status *status);

JABBERWERX_API jw_client_reconnect_statustype
jw_client_reconnect_get_status(jw_client_reconnect_status *status);

JABBERWERX_API uint32_t
jw_client_reconnect_get_countdown(jw_client_reconnect_status *status);

JABBERWERX_API uint32_t
jw_client_reconnect_get_attempts(jw_client_reconnect_status *status);

JABBERWERX_API bool jw_client_send_stanza(jw_client   *client,
                                          jw_dom_node *stanza,
                                          jw_err      *err);

JABBERWERX_API bool jw_client_track_iq(jw_client         *client,
                                       jw_dom_node       *iq,
                                       jw_tracker_cb_func cb,
                                       void              *user_data,
                                       uint32_t           timeout_sec,
                                       jw_err            *err);

#ifdef __cplusplus
}
#endif

#endif  /* JABBERWERX_CLIENT_H */