/**
|
* @file
|
*
|
* @brief 发布订阅和请求应答的客户端
|
*
|
* @details 向BusService发布消息或者在BusService上订阅感兴趣的消息
|
*/
|
|
|
|
#ifndef __NET_MOD_SOCKET_H__
|
#define __NET_MOD_SOCKET_H__
|
|
#include "net_mod_socket.h"
|
|
#ifdef __cplusplus
|
extern "C" {
|
#endif
|
|
|
|
|
|
|
/**
|
* @brief 创建 net_mod_socket
|
* @return net_mod_socket 句柄
|
*/
|
void * net_mod_socket_open();
|
|
/**
|
* @brief 关闭 net_mod_socket
|
*/
|
void net_mod_socket_close(void *_sockt);
|
|
|
|
/**
|
* @brief 绑定端口到socket, 如果不绑定则系统自动分配一个
|
*
|
* @param key 绑定的key值
|
* @return 0是成功，其他值是失败的错误码
|
*/
|
int net_mod_socket_bind(void * _socket, int key);
|
|
/**
|
* @brief 强制绑定端口到socket, 适用于程序非正常关闭的情况下，重启程序绑定原来还没释放的key
|
*
|
* @return 0是成功， 其他值是失败的错误码
|
*/
|
int net_mod_socket_force_bind(void * _socket, int key);
|
|
/**
|
* @brief 发送信息,发送完成才返回
|
*
|
* @param buf 消息存放的缓存地址
|
* @param size 消息长度
|
* @param param key 发送给谁
|
*
|
* @return 0是成功， 其他值是失败的错误码
|
*/
|
int net_mod_socket_sendto(void *_socket, const void *buf, const int size, const int key);
|
|
/**
|
* @brief 发送信息，在指定时间内没发送完成也返回。
|
*
|
* @param buf 消息存放的缓存地址
|
* @param size 消息长度
|
* @param param key 发送给谁
|
* @param sec 秒
|
* @param nsec 纳秒
|
*
|
* @return 0是成功， 其他值是失败的错误码
|
*/
|
int net_mod_socket_sendto_timeout(void *_socket, const void *buf, const int size, const int key, int sec, int nsec);
|
|
/**
|
* @brief 发送信息，无论是否发送完成立刻返回。
|
*
|
* @param buf 消息存放的缓存地址
|
* @param size 消息长度
|
* @param param key 发送给谁
|
*
|
* @return 0是成功， 其他值是失败的错误码
|
*/
|
int net_mod_socket_sendto_nowait(void *_socket, const void *buf, const int size, const int key);
|
|
/**
|
* @brief 等待接收信息，直到有消息接受到才返回
|
*
|
* @param buf 接受到的消息存放的缓存地址，该buf使用完成后需要手动释放
|
* @param size 接受到消息的长度
|
* @param key 从谁哪里收到的信息
|
*
|
* @return 0是成功， 其他值是失败的错误码
|
*/
|
int net_mod_socket_recvfrom(void *_socket, void **buf, int *size, int *key);
|
|
/**
|
* @brief 等待接收信息，在指定的时间内即使没有接受到消息也要返回
|
*
|
* @param buf 接受到的消息存放的缓存地址，该buf使用完成后需要手动释放
|
* @param size 接受到消息的长度
|
* @param key 从谁哪里收到的信息
|
* @param sec 秒
|
* @param nsec 纳秒
|
*
|
* @return 0是成功， 其他值是失败的错误码
|
*/
|
int net_mod_socket_recvfrom_timeout(void *_socket, void **buf, int *size, int *key, int sec, int nsec);
|
|
/**
|
* @brief 等待接收信息，直到有消息接受到才返回
|
*
|
* @param buf 接受到的消息存放的缓存地址，该buf使用完成后需要手动释放
|
* @param size 接受到消息的长度
|
* @param key 从谁哪里收到的信息
|
*
|
* @return 0是成功，其他值是失败的错误码
|
*/
|
int net_mod_socket_recvfrom_nowait(void *_socket, void **buf, int *size, int *key);
|
|
|
|
/**
|
* @brief 接受消息，并把callback函数返回的数据发送回对方，一直等待完成
|
*
|
* @param recvbuf 接受到的消息存放的缓存地址，该buf使用完成后需要手动释放
|
* @param recvsize 接受到消息的长度
|
* @param key 从谁哪里收到的信息
|
* @callback void (*recv_callback_fn)(void **sendbuf, int *sendsize)
|
* sendbuf 和 sendsize是callbak_fn回调函数的返回值, 分别表示返回的数据，和返回数据的长度。
|
*
|
* @return 0是成功， 其他值是失败的错误码
|
*/
|
int net_mod_socket_recvandsend(void *_socket, void **recvbuf, int *recvsize, int *key, recv_callback_fn callback);
|
|
/**
|
* @brief 接受消息，并把callback函数返回的数据发送回对方，在指定的时间内即使没有完成也返回
|
*
|
* @param recvbuf 接受到的消息存放的缓存地址，该buf使用完成后需要手动释放
|
* @param recvsize 接受到消息的长度
|
* @param key 从谁哪里收到的信息
|
* @callback void (*recv_callback_fn)(void **sendbuf, int *sendsize)
|
* sendbuf 和 sendsize是callbak_fn回调函数的返回值, 分别表示返回的数据，和返回数据的长度。
|
*
|
* @param sec 秒
|
* @param nsec 纳秒
|
*
|
* @return 0是成功， 其他值是失败的错误码
|
*/
|
int net_mod_socket_recvandsend_timeout(void *_socket, void **recvbuf, int *recvsize, int *key, recv_callback_fn callback,
|
int sec, int nsec ) ;
|
|
|
/**
|
* @brief 接受消息，并把callback函数返回的数据发送回对方，无论成功与否立刻返回
|
*
|
* @param recvbuf 接受到的消息存放的缓存地址，该buf使用完成后需要手动释放
|
* @param recvsize 接受到消息的长度
|
* @param key 从谁哪里收到的信息
|
* @callback void (*recv_callback_fn)(void **sendbuf, int *sendsize)
|
* sendbuf 和 sendsize是callbak_fn回调函数的返回值, 分别表示返回的数据，和返回数据的长度。
|
*
|
* @return 0是成功， 其他值是失败的错误码
|
*/
|
int net_mod_socket_recvandsend_nowait(void *_socket, void **recvbuf, int *recvsize, int *key, recv_callback_fn callback) ;
|
|
|
|
/**
|
* @brief 跨机器发送消息并接受返回的应答消息，直到发送完成才返回
|
*
|
* 向node_arr 中的所有网络节点发送请求消息，节点的返回信息汇总并存储在recv_arr中
|
* @param node_arr 网络节点组,
|
* @param node_arr_len该数组长度.如果IP为空则为本地发送。
|
* @param send_buf 发送的消息
|
* @param send_size 该消息体的长度
|
* @param recv_arr 返回的应答消息数组
|
* @param recv_arr_size 返回的应答消息数组长度
|
*
|
* @return 成功发送的节点的个数
|
*
|
*/
|
int net_mod_socket_sendandrecv(void *_sockt, net_node_t *node_arr, int arrlen, void *send_buf, int send_size,
|
net_mod_recv_msg_t ** recv_arr, int *recv_arr_size) ;
|
|
|
/**
|
* @brief 跨机器发送消息并接受返回的应答消息，在指定时间内即使没有发送完成也返回
|
*
|
* 向node_arr 中的所有网络节点发送请求消息，节点的返回信息汇总并存储在recv_arr中
|
* @param node_arr 网络节点组,
|
* @param node_arr_len该数组长度.如果IP为空则为本地发送。
|
* @param send_buf 发送的消息
|
* @param send_size 该消息体的长度
|
* @param recv_arr 返回的应答消息数组
|
* @param recv_arr_size 返回的应答消息数组长度
|
* @param timeout 等待时间(豪秒，即千分之一秒)
|
*
|
* @return 成功发送的节点的个数
|
*
|
*/
|
int net_mod_socket_sendandrecv_timeout(void *_sockt, net_node_t *node_arr, int arrlen, void *send_buf, int send_size,
|
net_mod_recv_msg_t ** recv_arr, int *recv_arr_size, int timeout);
|
|
|
/**
|
* @brief 跨机器发送消息并接受返回的应答消息，不管是否发送完成立刻返回
|
*
|
* 向node_arr 中的所有网络节点发送请求消息，节点的返回信息汇总并存储在recv_arr中
|
* @param node_arr 网络节点组,
|
* @param node_arr_len该数组长度.如果IP为空则为本地发送。
|
* @param send_buf 发送的消息
|
* @param send_size 该消息体的长度
|
* @param recv_arr 返回的应答消息数组
|
* @param recv_arr_size 返回的应答消息数组长度
|
*
|
* @return 成功发送的节点的个数
|
*
|
*/
|
int net_mod_socket_sendandrecv_nowait(void *_sockt, net_node_t *node_arr, int arrlen, void *send_buf, int send_size,
|
net_mod_recv_msg_t ** recv_arr, int *recv_arr_size) ;
|
|
|
|
/**
|
* @brief 向node_arr中的所有网络节点发布消息
|
*
|
* @param node_arr 网络节点组, @node_arr_len该数组长度
|
* @param topic 主题，
|
* @param topic_size 该主题的长度
|
* @param content 内容，
|
* @param content_size 内容长度
|
*
|
* @return 成功发布的节点的个数
|
*/
|
int net_mod_socket_pub(void *_sockt, net_node_t *node_arr, int node_arr_len, char *topic, int topic_size, void *content, int content_size);
|
|
|
/**
|
* @brief 向node_arr中的所有网络节点发布消息，在指定时间内即使没有发布完成也返回
|
*
|
* @param node_arr 网络节点组, @node_arr_len该数组长度
|
* @param topic 主题，
|
* @param topic_size 该主题的长度
|
* @param content 内容，
|
* @param content_size 内容长度
|
* @param msec 超时时间（毫秒，既千分之一秒）
|
*
|
* @return 成功发布的节点的个数
|
*/
|
int net_mod_socket_pub_timeout(void *_sockt, net_node_t *node_arr, int node_arr_len, char *topic, int topic_size, void *content, int content_size, int msec);
|
|
|
/**
|
* @brief 向node_arr中的所有网络节点发布消息，不管是否发布完成立刻返回
|
*
|
* @param node_arr 网络节点组, @node_arr_len该数组长度
|
* @param topic 主题，
|
* @param topic_size 该主题的长度
|
* @param content 内容，
|
* @param content_size 内容长度
|
*
|
* @return 成功发布的节点的个数
|
*/
|
int net_mod_socket_pub_nowait(void *_sockt, net_node_t *node_arr, int node_arr_len, char *topic, int topic_size, void *content, int content_size);
|
|
/**
|
* @brief 订阅感兴趣主题的消息
|
*
|
* @param topic 主题
|
* @param size 主题长度
|
*
|
* @return 0是成功，其他值是失败的错误码
|
*
|
*/
|
int net_mod_socket_sub(void * _socket, void *topic, int size);
|
|
/**
|
* @brief 订阅感兴趣主题的消息, 在指定的时间内即使未完成订阅也返回
|
*
|
* @param topic 主题
|
* @param size 主题长度
|
* @param sec 秒
|
* @param nsec 纳秒
|
*
|
* @return 0是成功，其他值是失败的错误码
|
*/
|
int net_mod_socket_sub_timeout(void * _socket, void *topic, int size, int sec, int nsec);
|
|
|
/**
|
* @brief 订阅感兴趣主题的消息，不管是否完成订阅立刻返回
|
*
|
* @param topic 主题
|
* @param size 主题长度
|
*
|
* @return 0是成功，其他值是失败的错误码
|
*
|
*/
|
int net_mod_socket_sub_nowait(void * _socket, void *topic, int size);
|
|
|
/**
|
* @brief 取消订阅指定主题
|
*
|
* @param topic 主题,主题为空时取消全部订阅
|
* @param size 主题长度
|
*
|
* @return 0是成功，其他值是失败的错误码
|
*/
|
int net_mod_socket_desub(void * _socket, void *topic, int size);
|
|
|
/**
|
* @brief 取消订阅指定主题，在指定时间内即使未完成取消订阅任务也返回
|
*
|
* @param topic 主题,主题为空时取消全部订阅
|
* @param size 主题长度
|
* @param sec 秒
|
* @param nsec 纳秒
|
*
|
* @return 0是成功，其他值是失败的错误码
|
*/
|
int net_mod_socket_desub_timeout(void * _socket, void *topic, int size, int sec, int nsec);
|
|
|
/**
|
* @brief 取消订阅指定主题，不管是否完成取消订阅任务都要立刻返回
|
*
|
* @param topic 主题,主题为空时取消全部订阅
|
* @param size 主题长度
|
*
|
* @return 0是成功，其他值是失败的错误码
|
*/
|
int net_mod_socket_desub_nowait(void * _socket, void *topic, int size);
|
|
|
/**
|
* @brief 获取soket的key
|
* @return key
|
*/
|
int net_mod_socket_get_key(void * _socket) ;
|
|
|
/**
|
* @brief 销毁sendandrecv方法返回的消息组
|
*
|
* @param arr 消息组
|
* @param size 消息组的长度
|
*/
|
void net_mod_socket_free_recv_msg_arr(net_mod_recv_msg_t * arr, int size);
|
|
|
/**
|
* @brief 释放存储接收信息的buf
|
*/
|
void net_mod_socket_free(void *buf) ;
|
|
|
/**
|
* @brief 删除key对应的共享队列，并在bus里删除该key的订阅
|
*
|
* @return 删除的key的数量
|
*/
|
int shm_mod_socket_remove_key(int key);
|
|
/**
|
* @brief 批量删除key对应的共享队列，并在bus里删除该key的订阅
|
*
|
* @return 删除的key的数量
|
*/
|
int shm_mod_socket_remove_keys(int keys[], int length);
|
|
#ifdef __cplusplus
|
}
|
#endif
|
|
#endif
|
