amps.h

Go to the documentation of this file.

/* ////////////////////////////////////////////////////////////////////////
 *
 * Copyright (c) 2010-2023 60East Technologies Inc., All Rights Reserved.
 *
 * This computer software is owned by 60East Technologies Inc. and is
 * protected by U.S. copyright laws and other laws and by international
 * treaties.  This computer software is furnished by 60East Technologies
 * Inc. pursuant to a written license agreement and may be used, copied,
 * transmitted, and stored only in accordance with the terms of such
 * license agreement and with the inclusion of the above copyright notice.
 * This computer software or any other copies thereof may not be provided
 * or otherwise made available to any other person.
 *
 * U.S. Government Restricted Rights.  This computer software: (a) was
 * developed at private expense and is in all respects the proprietary
 * information of 60East Technologies Inc.; (b) was not developed with
 * government funds; (c) is a trade secret of 60East Technologies Inc.
 * for all purposes of the Freedom of Information Act; and (d) is a
 * commercial item and thus, pursuant to Section 12.212 of the Federal
 * Acquisition Regulations (FAR) and DFAR Supplement Section 227.7202,
 * Government's use, duplication or disclosure of the computer software
 * is subject to the restrictions set forth by 60East Technologies Inc..
 *
 * ////////////////////////////////////////////////////////////////////// */

#ifndef _AMPS_H_
#define _AMPS_H_

#ifdef _WIN32
#include <WinSock2.h>
#else
#include <netdb.h>
#include <netinet/ip.h>
#include <errno.h>
#include <pthread.h>
#include <unistd.h>
#endif
#include <string.h>
#include <time.h>
#include <stdio.h>
#include "amps_generated.h"

#ifdef _WIN32
#ifdef AMPS_SHARED
#ifdef AMPS_BUILD
#define AMPSDLL __declspec(dllexport)
#else
#define AMPSDLL __declspec(dllimport)
#endif
#else
#define AMPSDLL
#endif
#define AMPS_USLEEP(x) Sleep((DWORD)(x)/(DWORD)1000);
#define AMPS_YIELD() SwitchToThread()
typedef HANDLE AMPS_THREAD_T;
typedef SOCKET AMPS_SOCKET;
typedef __int32            amps_int32_t;
typedef unsigned __int32   amps_uint32_t;
typedef __int64            amps_int64_t;
typedef unsigned __int64   amps_uint64_t;
#else
#define AMPSDLL
#define AMPS_USLEEP(x) usleep((unsigned int)(x));
#define AMPS_YIELD() sched_yield()
typedef pthread_t AMPS_THREAD_T;
typedef int AMPS_SOCKET;
typedef int32_t amps_int32_t;
typedef uint32_t amps_uint32_t;
typedef int64_t amps_int64_t;
typedef uint64_t amps_uint64_t;
#endif

#if defined(_WIN32) || defined(__SSE_4_2__)
#define AMPS_SSE_42 1
#endif

#ifdef __cplusplus
extern "C" {
#endif

    typedef char amps_char;

    typedef void* amps_handle;

    typedef enum
    {
        AMPS_E_OK,
        AMPS_E_MEMORY,
        AMPS_E_COMMAND,
        AMPS_E_CONNECTION,
        AMPS_E_TOPIC,
        AMPS_E_FILTER,
        AMPS_E_RETRY,
        AMPS_E_DISCONNECTED,
        AMPS_E_CONNECTION_REFUSED,
        AMPS_E_STREAM,
        AMPS_E_URI,
        AMPS_E_TRANSPORT_TYPE,
        AMPS_E_USAGE,
        AMPS_E_SSL
    } amps_result;

    typedef amps_result(*amps_handler)(amps_handle, void*);
    typedef void(*amps_predisconnect_handler)(amps_handle, unsigned, void*);


    AMPSDLL amps_handle amps_client_create(
        const amps_char*   clientName);

    AMPSDLL amps_result amps_client_set_name(
        amps_handle handle,
        const amps_char*   clientName);

    AMPSDLL amps_result amps_client_connect(
        amps_handle handle,
        const amps_char*  uri);

    AMPSDLL void amps_client_disconnect(
        amps_handle handle);

    AMPSDLL void amps_client_destroy(
        amps_handle handle);

    AMPSDLL size_t amps_client_get_error(
        amps_handle  client,
        amps_char*   errorMessageOut,
        size_t       bufferSize);

    AMPSDLL amps_result amps_client_send(
        amps_handle client,
        amps_handle message);

    AMPSDLL amps_result amps_client_send_with_version(
        amps_handle client,
        amps_handle message,
        unsigned* version_out);


    AMPSDLL void amps_client_set_message_handler(
        amps_handle client,
        amps_handler messageHandler,
        void* userData);

    AMPSDLL void amps_client_set_predisconnect_handler(
        amps_handle client,
        amps_predisconnect_handler predisconnectHandler,
        void* userData);

    AMPSDLL void amps_client_set_disconnect_handler(
        amps_handle client,
        amps_handler disconnectHandler,
        void* userData);

    AMPSDLL amps_handle amps_client_get_transport(
        amps_handle client);

    AMPSDLL amps_result
    amps_client_attempt_reconnect(amps_handle client, unsigned version);

    AMPSDLL amps_handle amps_message_create(amps_handle client);

    AMPSDLL amps_handle amps_message_copy(amps_handle message);

    AMPSDLL void amps_message_destroy(amps_handle message);

    AMPSDLL void amps_message_reset(amps_handle message);

    AMPSDLL void amps_message_get_field_value(
        amps_handle message,
        FieldId field,
        const amps_char**  value_ptr,
        size_t* length_ptr);

    AMPSDLL void amps_message_set_field_value(
        amps_handle message,
        FieldId field,
        const amps_char* value,
        size_t   length);

    AMPSDLL void amps_message_assign_field_value(
        amps_handle message,
        FieldId field,
        const amps_char* value,
        size_t   length);

    AMPSDLL void amps_message_set_field_value_nts(
        amps_handle message,
        FieldId field,
        const amps_char* value);


    AMPSDLL void amps_message_set_field_guid(
        amps_handle message,
        FieldId field);

    AMPSDLL void amps_message_set_data(
        amps_handle message,
        const amps_char* value,
        size_t   length);

    AMPSDLL void amps_message_assign_data(
        amps_handle message,
        const amps_char* value,
        size_t   length);

    AMPSDLL void amps_message_set_data_nts(
        amps_handle message,
        const amps_char* value);

    AMPSDLL void amps_message_get_data(
        amps_handle message,
        amps_char** value_ptr,
        size_t*     length_ptr);

    AMPSDLL unsigned long amps_message_get_field_long(
        amps_handle message,
        FieldId field);

    AMPSDLL amps_uint64_t amps_message_get_field_uint64(
        amps_handle message,
        FieldId field);

    AMPSDLL amps_result amps_client_set_read_timeout(
        amps_handle client,
        int readTimeout);


    AMPSDLL amps_result amps_client_set_idle_time(
        amps_handle client,
        int idleTime);

typedef void(*amps_transport_filter_function)(const unsigned char*,size_t,short,void*);

    AMPSDLL amps_result amps_client_set_transport_filter_function(
        amps_handle client,
        amps_transport_filter_function filter,
        void* userData);

typedef amps_result(*amps_thread_created_callback)(AMPS_THREAD_T,void*);

    AMPSDLL amps_result amps_client_set_thread_created_callback(
        amps_handle client,
        amps_thread_created_callback callback,
        void* userData);

    AMPSDLL AMPS_SOCKET
    amps_tcp_get_socket(amps_handle transport);

    AMPSDLL AMPS_SOCKET
    amps_tcps_get_socket(amps_handle transport);

    AMPSDLL void*
    amps_tcps_get_SSL(amps_handle transport);

/*
 * Returns the current wall-clock time in milliseconds
 */
    AMPSDLL amps_uint64_t
    amps_now(void);


AMPSDLL int amps_ssl_init(const char* dllPath_);

AMPSDLL int amps_ssl_set_verify(int mode_);

AMPSDLL int amps_ssl_load_verify_locations(const char* caFile_, const char* caPath_);

AMPSDLL void amps_ssl_free(void);

AMPSDLL const char* amps_ssl_get_error(void);

AMPSDLL void amps_noOpFn(void*);

/*
 * Internal API for use by the python client.
 */
AMPSDLL void amps_set_waiting_function(void*);
AMPSDLL void amps_invoke_waiting_function(void);
AMPSDLL void amps_set_remove_route_function(void*);
AMPSDLL void amps_invoke_remove_route_function(void*);
AMPSDLL void amps_set_copy_route_function(void*);
AMPSDLL void* amps_invoke_copy_route_function(void*);

#ifdef __cplusplus
}
#if !defined(_AMPS_BUILD_C_CLIENT) && !defined(_AMPS_SKIP_AMPSPLUSPLUS)
#include <ampsplusplus.hpp>
#endif
#endif

#endif