iotcs_messaging.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015, 2018, Oracle and/or its affiliates. All rights reserved.
 *
 * This software is dual-licensed to you under the MIT License (MIT) and
 * the Universal Permissive License (UPL). See the LICENSE file in the root
 * directory for license terms. You may choose either license, or both.
 */

#ifndef IOTCS_MESSAGE_DISPATCHER_H_
#define IOTCS_MESSAGE_DISPATCHER_H_

#include "iotcs_message.h"

#ifdef  __cplusplus
extern "C" {
#endif

    /*
     * IOT CS Message Dispatcher part
     */
#if defined IOTCS_MESSAGE_DISPATCHER || defined IOTCS_DOXYGEN

    typedef void(*iotcs_message_dispatcher_delivery_callback)(iotcs_message *message);

    typedef void(*iotcs_message_dispatcher_error_callback)(iotcs_message *message, iotcs_result result,
            const char *fail_reason);

    void iotcs_message_dispatcher_set_delivery_callback(iotcs_message_dispatcher_delivery_callback delivery_cb);

    void iotcs_message_dispatcher_set_error_callback(iotcs_message_dispatcher_error_callback error_cb);

    iotcs_result iotcs_message_dispatcher_queue(iotcs_message* message);

#if defined IOTCS_IMPLICIT_EDGE_COMPUTING || defined IOTCS_DOXYGEN

    iotcs_result iotcs_offer(iotcs_message *message);
#endif
#endif

#if !defined IOTCS_MESSAGE_DISPATCHER || defined IOTCS_DOXYGEN

    iotcs_result iotcs_send(iotcs_message messages[], size_t len);

    iotcs_request_message* iotcs_receive(int32_t timeout);

    void iotcs_request_message_free(iotcs_request_message* message);

#endif /* #else #ifdef IOTCS_MESSAGE_DISPATCHER */

    /*
     * IOT CS Request Dispatcher part
     */

    typedef void (*iotcs_resource_handler)(iotcs_request_message *request, void *arg, iotcs_message *response);

#if !defined IOTCS_MESSAGE_DISPATCHER || defined IOTCS_DOXYGEN

    iotcs_result iotcs_request_dispatcher_init(void);

    void iotcs_request_dispatcher_finalize(void);

    void iotcs_request_dispatcher_dispatch(iotcs_request_message* request_message, iotcs_message* response_message);

#endif /* #ifndef IOTCS_MESSAGE_DISPATCHER */

    iotcs_result iotcs_register_request_handler(const char* endpoint_id, const char* path, iotcs_resource_handler handler, void* arg);

    iotcs_result iotcs_unregister_request_handler_all(iotcs_resource_handler handler);

    iotcs_result iotcs_unregister_request_handler(const char* endpoint_id, const char* path);

    iotcs_resource_handler iotcs_get_request_handler(const char* endpoint_id, const char* path);

#if defined IOTCS_STORAGE_SUPPORT || !defined IOTCS_DOXYGEN
    struct iotcs_uri_object_t;
    typedef struct iotcs_uri_object_t iotcs_storage_object;
#if !defined IOTCS_DOXYGEN

    typedef struct iotcs_uri_object_t iotcs_external_object;
#endif
#endif

#ifdef  __cplusplus
}
#endif

#endif  /* IOTCS_MESSAGE_DISPATCHER_H_ */