doxygen

jimi-wzq

2021-01-12 48e47110397c894716525db219e53300c08f64dd

 src/socket/net_mod_socket_wrapper.h

@@ -1,3 +1,13 @@
/**
 * @file
 * 
 * @brief 发布订阅和请求应答的客户端
 *
 * @details 向BusService发布消息或者在BusService上订阅感兴趣的消息
 */



#ifndef __NET_MOD_SOCKET_H__
#define __NET_MOD_SOCKET_H__

@@ -7,146 +17,313 @@
extern "C" {
#endif

struct net_mod_socket_t
{
   NetModSocket *sockt;
};
 




/**
 * 创建
 * @brief 创建 net_mod_socket
 * @return net_mod_socket 句柄
 */
void * net_mod_socket_open();

/**
 * 关闭
 * @brief 关闭 net_mod_socket
 */
void net_mod_socket_close(void *_sockt);



/**
 * 绑定端口到socket, 如果不绑定则系统自动分配一个
 * @return 0 成功， 其他值 失败的错误码
*/
 * @brief 绑定端口到socket, 如果不绑定则系统自动分配一个
 *
 * @param key 绑定的key值
 * @return 0是成功，其他值是失败的错误码
 */
int net_mod_socket_bind(void * _socket, int key);

/**
 * 强制绑定端口到socket, 适用于程序非正常关闭的情况下，重启程序绑定原来还没释放的key
 * @return 0 成功， 其他值 失败的错误码
*/
 * @brief 强制绑定端口到socket, 适用于程序非正常关闭的情况下，重启程序绑定原来还没释放的key
 *
 * @return 0是成功， 其他值是失败的错误码
 */
int net_mod_socket_force_bind(void * _socket, int key);

/**
 * 发送信息
 * @key 发送给谁
 * @return 0 成功， 其他值 失败的错误码
 * @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);
// 发送信息超时返回。 @sec 秒 ， @nsec 纳秒

/**
 * @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);

/**
 * 接收信息
 * @key 从谁哪里收到的信息
 * @return 0 成功， 其他值 失败的错误码
*/
 * @brief 等待接收信息，直到有消息接受到才返回
 *
 * @param buf 接受到的消息存放的缓存地址，该buf使用完成后需要手动释放
 * @param size 接受到消息的长度
 * @param key 从谁哪里收到的信息
 * 
 * @return 0是成功， 其他值是失败的错误码
 */
int net_mod_socket_recvfrom(void *_socket, void **buf, int *size, int *key);
// 接受信息超时返回。 @sec 秒 ， @nsec 纳秒
/**
 * @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 跨机器发送消息并接受返回的应答消息，直到发送完成才返回
 *
 * 向node_arr 中的所有网络节点发送请求消息，节点的返回信息汇总并存储在recv_arr中
 * @node_arr 网络节点组, @node_arr_len该数组长度
 * @send_buf 发送的消息，@send_size 该消息体的长度
 * @recv_arr 返回的应答消息组，@recv_arr_size 该数组长度
 * @param node_arr 网络节点组, 
 * @param node_arr_len该数组长度.如果IP为空则为本地发送。
 * @param send_buf 发送的消息
 * @param send_size 该消息体的长度
 * @param recv_arr 返回的应答消息数组
 * @param recv_arr_size 返回的应答消息数组长度
 *
 * @return 成功发送的节点的个数
 * 优点：1某个节点的故障不会阻塞其他节点。2性能好
 * 缺点：不是线程安全的, 即不能有两个以上的线程同时使用这个对象的方法
 *
 */
int net_mod_socket_sendandrecv(void *_sockt, net_node_t *node_arr, int arrlen, void *send_buf, int send_size, 
extern 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) ;
 

/**
 * 如果建立连接的节点没有接受到消息等待timeout的时间后返回
 * @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 返回的应答消息数组长度
 * @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) ;


/**
 * 启动bus
 * 
 * @return 0 成功， 其他值 失败的错误码
*/
int  net_mod_socket_start_bus(void * _socket);


 /**
 * 向node_arr 中的所有网络节点发布消息
 * @node_arr 网络节点组, @node_arr_len该数组长度
 * @topic 主题，@topic_size 该主题的长度
 * @content 内容，@content_size 内容长度
 * @return 成功发布的节点的个数
 */
  * @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);
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 timeout);


/**
  * @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);

/**
 * 订阅指定主题
 * @topic 主题
 * @size 主题长度
 * @key 总线端口
 * @brief 订阅感兴趣主题的消息
 *
 * @param topic 主题
 * @param size 主题长度
 *
 * @return  0是成功，其他值是失败的错误码
 * 
 */
int  net_mod_socket_sub(void * _socket, void *topic, int size, int key);
// 超时返回。 @sec 秒 ， @nsec 纳秒
int  net_mod_socket_sub_timeout(void * _socket, void *topic, int size, int key, int sec, int nsec);
int  net_mod_socket_sub_nowait(void * _socket, void *topic, int size, int key);
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);


/**
 * 取消订阅指定主题
 * @topic 主题,主题为空时取消全部订阅
 * @size 主题长度
 * @key 总线端口
 * @brief 订阅感兴趣主题的消息，不管是否完成订阅立刻返回
 *
 * @param topic 主题
 * @param size 主题长度
 *
 * @return  0是成功，其他值是失败的错误码
 * 
 */
int  net_mod_socket_desub(void * _socket, void *topic, int size, int key);
// 超时返回。 @sec 秒 ， @nsec 纳秒
int  net_mod_socket_desub_timeout(void * _socket, void *topic, int size, int key, int sec, int nsec);
int  net_mod_socket_desub_nowait(void * _socket, void *topic, int size, int key);
int  net_mod_socket_sub_nowait(void * _socket, void *topic, int size);


/**
 * 获取soket端口号
 * @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) ;


/**
 * 销毁sendandrecv方法返回的消息组 
 * @arr 消息组
 * @size 消息组的长度
 * @brief 销毁sendandrecv方法返回的消息组 
 *
 * @param arr 消息组
 * @param size 消息组的长度
 */
void  net_mod_socket_free_recv_msg_arr(net_mod_recv_msg_t * arr, int size);


/**
 * 释放存储接收信息的buf
 * @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