agent.h

Go to the documentation of this file.

/* Copyright Inspirel Sp. z o.o. 2013-2015.
 * This file is part of YAMI4.
 *
 * YAMI4 is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * YAMI4 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with YAMI4.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef YAMI4INDUSTRY_AGENT_H
#define YAMI4INDUSTRY_AGENT_H

#include "callbacks.h"
#include "channel.h"
#include "common.h"
#include "limits.h"
#include "options.h"

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

#ifdef __cplusplus
extern "C"
{
#endif /* __cplusplus */

struct yami_agent
{
    int32_t listening_socket_;
    enum yami_protocol listening_protocol_;
    
    uint32_t last_core_message_id_;
    int64_t last_message_id_;
    
    yami_raw_message_function raw_message_callback_;
    yami_message_function message_callback_;
    yami_io_error_function io_error_callback_;
    yami_connection_event_function connection_callback_;
    
    struct yami_options options_;
    
    struct yami_channel * channels_array_;
    size_t channels_array_size_;
    
    struct yami_channel channels_[MAX_NUMBER_OF_CHANNELS];
};

void yami_init(struct yami_agent * self);

void yami_init_with_user_array(struct yami_agent * self,
    struct yami_channel channels_array[], size_t channels_array_size);

void yami_init_with_options(struct yami_agent * self,
    const struct yami_options * options);

void yami_init_with_options_ua(struct yami_agent * self,
    const struct yami_options * options,
    struct yami_channel channels_array[], size_t channels_array_size);

enum yami_result yami_clean(struct yami_agent * self);

void yami_set_io_error_callback(struct yami_agent * self,
    yami_io_error_function io_error_callback);

void yami_set_raw_message_callback(struct yami_agent * self,
    yami_raw_message_function raw_message_callback);

void yami_set_message_callback(struct yami_agent * self,
    yami_message_function message_callback);

void yami_set_connection_callback(struct yami_agent * self,
    yami_connection_event_function connection_callback);

enum yami_result yami_set_listener(struct yami_agent * self,
    const char target[]);

enum yami_result yami_open_connection(struct yami_agent * self,
    const char target[]);

enum yami_result yami_close_connection(struct yami_agent * self,
    const char target[]);

enum yami_result yami_is_output_channel_busy(const struct yami_agent * self,
    const char target[], int32_t * out_busy);

enum yami_result yami_post_raw_message(struct yami_agent * self,
    const char target[],
    const uint8_t header[], size_t header_size,
    const uint8_t body[], size_t body_size);

enum yami_result yami_post_message(struct yami_agent * self,
    const char target[], const char object_name[], const char message_name[],
    const uint8_t body[], size_t body_size,
    int64_t * out_message_id);

enum yami_result yami_post_reply(struct yami_agent * self,
    const char target[], int64_t message_id,
    const uint8_t body[], size_t body_size);

enum yami_result yami_post_reject(struct yami_agent * self,
    const char target[], int64_t message_id, const char reason[]);

enum yami_result yami_do_some_work(struct yami_agent * self,
    size_t timeout);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* YAMI4INDUSTRY_AGENT_H */