add doc

liuxiaolong

2020-12-21 eee585b6612857d33a5ccba09e0736fd4f49d43a

add doc

 doc/bus_server_socket_wrapper.c

New file
@@ -0,0 +1,40 @@
#include "bus_server_socket_wrapper.h"
#include "key_def.h"
static Logger *logger = LoggerFactory::getLogger();


/**
 * 创建
 */
void * bus_server_socket_wrapper_open() {
	
    NetModSocket *sockt = new NetModSocket;
    return (void *)sockt;
}

/**
 * 关闭
 */
void bus_server_socket_wrapper_close(void *_socket) {
    NetModSocket *sockt = (NetModSocket *)_socket;
    delete sockt;
}

/**
 * 启动bus
 * 
 * @return 0 成功， 其他值 失败的错误码
*/
int  bus_server_socket_wrapper_start_bus(void * _socket) {
    int ret;
    NetModSocket *sockt = (NetModSocket *)_socket;

    if( (ret = sockt->bind(BUS_KEY)) == 0) {
        sockt->start_bus();
        return 0;
    } else {
        logger->error("start bus failed");
        return -1;
    }
	
}

 doc/bus_server_socket_wrapper.h

New file
@@ -0,0 +1,33 @@
#ifndef _BUS_SERVER_SOCKET_WRAPPER_H_
#define _BUS_SERVER_SOCKET_WRAPPER_H_

#include "net_mod_socket.h"

#ifdef __cplusplus
extern "C" {
#endif

/**
 * 创建
 */
void * bus_server_socket_wrapper_open();

/**
 * 关闭
 */
void bus_server_socket_wrapper_close(void *_sockt);

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



#ifdef __cplusplus
}
#endif

#endif

 doc/net_mod_server_socket_wrapper.c

New file
@@ -0,0 +1,20 @@

#include "net_mod_server_socket_wrapper.h"

void *net_mod_server_socket_open(int port) {
    net_mod_server_socket_t *sockt = (net_mod_server_socket_t *)malloc(sizeof(net_mod_server_socket_t));
    sockt->sockt = new NetModServerSocket(port);
    return (void *)sockt;
}

void net_mod_server_socket_close(void *_sockt) {
    net_mod_server_socket_t *sockt = (net_mod_server_socket_t *)_sockt;
    delete sockt->sockt;
    free(sockt);

}

int net_mod_server_socket_start(void *_sockt) {
    net_mod_server_socket_t *sockt = (net_mod_server_socket_t *)_sockt;
    return sockt->sockt->start();
}

 doc/net_mod_server_socket_wrapper.h

New file
@@ -0,0 +1,39 @@
#ifndef __NET_MOD_SERVER_SOCKET_H__
#define __NET_MOD_SERVER_SOCKET_H__

#include "net_mod_server_socket.h"

#ifdef __cplusplus
extern "C" {
#endif

struct net_mod_server_socket_t
{
    NetModServerSocket *sockt;
};

/**
 * 创建
 */
void *net_mod_server_socket_open(int port) ;

/**
 * 关闭
 */
void net_mod_server_socket_close(void *_sockt) ;

/**
 * 启动
 * @return 0 success, 其他 failture
 */
int net_mod_server_socket_start(void *_sockt);





#ifdef __cplusplus
}
#endif

#endif

 doc/net_mod_socket_wrapper.c

New file
@@ -0,0 +1,221 @@
#include "net_mod_socket_wrapper.h"




/**
 * 创建
 */
void * net_mod_socket_open() {
    net_mod_socket_t *sockt = (net_mod_socket_t *)malloc(sizeof(net_mod_socket_t));
    sockt->sockt = new NetModSocket;
    return (void *)sockt;
}

/**
 * 关闭
 */
void net_mod_socket_close(void *_socket) {
    net_mod_socket_t *sockt = (net_mod_socket_t *)_socket;
    delete sockt->sockt;
    free(sockt);
}
 


/**
 * 绑定端口到socket, 如果不绑定则系统自动分配一个
 * @return 0 成功， 其他值 失败的错误码
*/
int net_mod_socket_bind(void * _socket, int port){
    net_mod_socket_t *sockt = (net_mod_socket_t *)_socket;
    return sockt->sockt->bind(port);
}

/**
 * 强制绑定端口到socket, 适用于程序非正常关闭的情况下，重启程序绑定原来还没释放的key
 * @return 0 成功， 其他值 失败的错误码
*/
int net_mod_socket_force_bind(void * _socket, int port) {
    net_mod_socket_t *sockt = (net_mod_socket_t *)_socket;
    return sockt->sockt->force_bind(port);
}
/**
 * 发送信息
 * @port 发送给谁
 * @return 0 成功， 其他值 失败的错误码
 */
int net_mod_socket_sendto(void *_socket, const void *buf, const int size, const int port) {
    net_mod_socket_t *sockt = (net_mod_socket_t *)_socket;
    return sockt->sockt->sendto(buf, size, port);
}
// 发送信息超时返回。 @sec 秒 ， @nsec 纳秒
int net_mod_socket_sendto_timeout(void *_socket, const void *buf, const int size, const int port, int sec, int nsec){
    net_mod_socket_t *sockt = (net_mod_socket_t *)_socket;
    return sockt->sockt->sendto_timeout(buf, size, port, sec, nsec);
}
// 发送信息立刻返回。
int net_mod_socket_sendto_nowait(void *_socket, const void *buf, const int size, const int port){
    net_mod_socket_t *sockt = (net_mod_socket_t *)_socket;
    return sockt->sockt->sendto_nowait(buf, size, port);
}

/**
 * 接收信息
 * @port 从谁哪里收到的信息
 * @return 0 成功， 其他值 失败的错误码
*/
int net_mod_socket_recvfrom(void *_socket, void **buf, int *size, int *port){
    net_mod_socket_t *sockt = (net_mod_socket_t *)_socket;
    return sockt->sockt->recvfrom(buf, size, port);
}
// 接受信息超时返回。 @sec 秒 ， @nsec 纳秒
int net_mod_socket_recvfrom_timeout(void *_socket, void **buf, int *size, int *port, int sec, int nsec){
    net_mod_socket_t *sockt = (net_mod_socket_t *)_socket;
    return sockt->sockt->recvfrom_timeout(buf, size, port, sec, nsec);
}
int net_mod_socket_recvfrom_nowait(void *_socket, void **buf, int *size, int *port){
    net_mod_socket_t *sockt = (net_mod_socket_t *)_socket;
    return sockt->sockt->recvfrom_nowait(buf, size, port);
}


  
/**
 * 如果建立连接的节点没有接受到消息会一直等待
 * 向node_arr 中的所有网络节点发送请求消息，节点的返回信息汇总并存储在recv_arr中
 * @node_arr 网络节点组, @node_arr_len该数组长度
 * @send_buf 发送的消息，@send_size 该消息体的长度
 * @recv_arr 返回的应答消息组，@recv_arr_size 该数组长度
 * @return 成功发送的节点的个数
 * 优点：1某个节点的故障不会阻塞其他节点。2性能好
 * 缺点：不是线程安全的, 即不能有两个以上的线程同时使用这个对象的方法
 */
int net_mod_socket_sendandrecv(void *_socket, net_node_t *node_arr, int arrlen, void *send_buf, int send_size, 
  net_mod_recv_msg_t ** recv_arr, int *recv_arr_size){
    net_mod_socket_t *sockt = (net_mod_socket_t *)_socket;
    return sockt->sockt->sendandrecv(node_arr,  arrlen, send_buf,  send_size, recv_arr, recv_arr_size);
}
/**
 * 如果建立连接的节点没有接受到消息等待timeout的时间后返回
 * @timeout 等待时间，单位是千分之一秒
*/
int net_mod_socket_sendandrecv_timeout(void *_socket, 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){
    net_mod_socket_t *sockt = (net_mod_socket_t *)_socket;
    return sockt->sockt->sendandrecv_timeout(node_arr,  arrlen, send_buf,  send_size, recv_arr, recv_arr_size, timeout);
}

int net_mod_socket_sendandrecv_nowait(void *_socket, net_node_t *node_arr, int arrlen, void *send_buf, int send_size, 
  net_mod_recv_msg_t ** recv_arr, int *recv_arr_size) {
    net_mod_socket_t *sockt = (net_mod_socket_t *)_socket;
    return sockt->sockt->sendandrecv_nowait(node_arr,  arrlen, send_buf,  send_size, recv_arr, recv_arr_size);
}

 

 /**
 * 向node_arr 中的所有网络节点发布消息
 * @node_arr 网络节点组, @node_arr_len该数组长度
 * @topic 主题，@topic_size 该主题的长度
 * @content 内容，@content_size 内容长度
 * @return 成功发布的节点的个数
 */
int net_mod_socket_pub(void *_socket, net_node_t *node_arr, int node_arr_len, char *topic, int topic_size, void *content, int content_size) {
    net_mod_socket_t *sockt = (net_mod_socket_t *)_socket;
    return sockt->sockt->pub(node_arr, node_arr_len, topic, topic_size, content, content_size);
}
int net_mod_socket_pub_timeout(void *_socket, net_node_t *node_arr, int node_arr_len, char *topic, int topic_size, void *content, int content_size, int msec){
    net_mod_socket_t *sockt = (net_mod_socket_t *)_socket;
    return sockt->sockt->pub_timeout(node_arr, node_arr_len, topic, topic_size, content, content_size, msec);
}
int net_mod_socket_pub_nowait(void *_socket, net_node_t *node_arr, int node_arr_len, char *topic, int topic_size, void *content, int content_size){
    net_mod_socket_t *sockt = (net_mod_socket_t *)_socket;
    return sockt->sockt->pub_nowait(node_arr, node_arr_len, topic, topic_size, content, content_size);
}





/**
 * 订阅指定主题
 * @topic 主题
 * @size 主题长度
 * @port 总线端口
 */
int  net_mod_socket_sub(void * _socket, void *topic, int size) {
    net_mod_socket_t *sockt = (net_mod_socket_t *)_socket;
    return sockt->sockt->sub((char *)topic,  size,  BUS_KEY);
}
// 超时返回。 @sec 秒 ， @nsec 纳秒
int  net_mod_socket_sub_timeout(void * _socket, void *topic, int size, int sec, int nsec){
    net_mod_socket_t *sockt = (net_mod_socket_t *)_socket;
    return sockt->sockt->sub_timeout((char *)topic,  size,  BUS_KEY, sec, nsec);
}
int  net_mod_socket_sub_nowait(void * _socket, void *topic, int size){
    net_mod_socket_t *sockt = (net_mod_socket_t *)_socket;
    return sockt->sockt->sub_nowait((char *)topic,  size,  BUS_KEY);
}


/**
 * 取消订阅指定主题
 * @topic 主题,主题为空时取消全部订阅
 * @size 主题长度
 * @port 总线端口
 */
int  net_mod_socket_desub(void * _socket, void *topic, int size) {
    net_mod_socket_t *sockt = (net_mod_socket_t *)_socket;
    return sockt->sockt->desub((char *)topic,  size,  BUS_KEY);
}
// 超时返回。 @sec 秒 ， @nsec 纳秒
int  net_mod_socket_desub_timeout(void * _socket, void *topic, int size, int sec, int nsec) {
    net_mod_socket_t *sockt = (net_mod_socket_t *)_socket;
    return sockt->sockt->desub_timeout((char *)topic,  size,  BUS_KEY, sec, nsec);
}
int  net_mod_socket_desub_nowait(void * _socket, void *topic, int size){
    net_mod_socket_t *sockt = (net_mod_socket_t *)_socket;
    return sockt->sockt->desub_nowait((char *)topic,  size,  BUS_KEY);
}



/**
 * 获取soket端口号
 */
int net_mod_socket_get_key(void * _socket) {
    net_mod_socket_t *sockt = (net_mod_socket_t *)_socket;
    return sockt->sockt->get_key();
}


/**
 * 释放存储接收信息的buf
 */
void net_mod_socket_free(void *buf) {
    free(buf);
}



/**
 * 销毁sendandrecv方法返回的消息组 
 * @arr 消息组
 * @size 消息组的长度
 */
void  net_mod_socket_free_recv_msg_arr(net_mod_recv_msg_t * arr, int len) {
	 
    return NetModSocket::free_recv_msg_arr(arr, len);
}



int shm_mod_socket_remove_keys(int keys[], int length){
    return ShmModSocket::remove_keys(keys, length);
}

int shm_mod_socket_remove_key(int key){
    int keys[] = {key};
    return ShmModSocket::remove_keys(keys, 1);
}

 doc/net_mod_socket_wrapper.h

New file
@@ -0,0 +1,160 @@
#ifndef __NET_MOD_SOCKET_H__
#define __NET_MOD_SOCKET_H__

#include "net_mod_socket.h"

#ifdef __cplusplus
extern "C" {
#endif

struct net_mod_socket_t
{
    NetModSocket *sockt;
};



/**
 * 创建
 */
void * net_mod_socket_open();

/**
 * 关闭
 */
void net_mod_socket_close(void *_sockt);



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

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

/**
 * 发送信息
 * @key 发送给谁
 * @return 0 成功， 其他值 失败的错误码
 */
int net_mod_socket_sendto(void *_socket, const void *buf, const int size, const int key);
// 发送信息超时返回。 @sec 秒 ， @nsec 纳秒
int net_mod_socket_sendto_timeout(void *_socket, const void *buf, const int size, const int key, int sec, int nsec);
// 发送信息立刻返回。
int net_mod_socket_sendto_nowait(void *_socket, const void *buf, const int size, const int key);

/**
 * 接收信息
 * @key 从谁哪里收到的信息
 * @return 0 成功， 其他值 失败的错误码
*/
int net_mod_socket_recvfrom(void *_socket, void **buf, int *size, int *key);
// 接受信息超时返回。 @sec 秒 ， @nsec 纳秒
int net_mod_socket_recvfrom_timeout(void *_socket, void **buf, int *size, int *key, int sec, int nsec);
int net_mod_socket_recvfrom_nowait(void *_socket, void **buf, int *size, int *key);

/**
 * 如果建立连接的节点没有接受到消息会一直等待
 * 向node_arr 中的所有网络节点发送请求消息，节点的返回信息汇总并存储在recv_arr中
 * @node_arr 网络节点组, @node_arr_len该数组长度.如果IP为空则为本地发送。
 * @send_buf 发送的消息，@send_size 该消息体的长度
 * @recv_arr 返回的应答消息组，@recv_arr_size 该数组长度
 * @return 成功发送的节点的个数
 * 优点：1某个节点的故障不会阻塞其他节点。2 性能好。 3 采用thread local技术即保证了线程安全，又可以使用连接池缓存连接
 */
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 等待时间，单位是千分之一秒
*/
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);

/**
 * 不等待立即返回
*/
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) ;



 /**
 * 向node_arr 中的所有网络节点发布消息
 * @node_arr 网络节点组, @node_arr_len该数组长度
 * @topic 主题，@topic_size 该主题的长度
 * @content 内容，@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);
/*
 * @msec 毫秒（千分之一秒）
 */
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);
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 总线端口
 */
int  net_mod_socket_sub(void * _socket, void *topic, int size);
// 超时返回。 @sec 秒 ， @nsec 纳秒
int  net_mod_socket_sub_timeout(void * _socket, void *topic, int size,  int sec, int nsec);
int  net_mod_socket_sub_nowait(void * _socket, void *topic, int size);


/**
 * 取消订阅指定主题
 * @topic 主题,主题为空时取消全部订阅
 * @size 主题长度
 * @key 总线端口
 */
int  net_mod_socket_desub(void * _socket, void *topic, int size);
// 超时返回。 @sec 秒 ， @nsec 纳秒
int  net_mod_socket_desub_timeout(void * _socket, void *topic, int size, int sec, int nsec);
int  net_mod_socket_desub_nowait(void * _socket, void *topic, int size);


/**
 * 获取soket端口号
 */
int net_mod_socket_get_key(void * _socket) ;


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


/**
 * 释放存储接收信息的buf
 */
void net_mod_socket_free(void *buf) ;


/**
 * 删除key对应的共享队列，并在bus里删除该key的订阅
 */
int shm_mod_socket_remove_key(int key);

/**
 * 批量删除key对应的共享队列，并在bus里删除该key的订阅
 */
int shm_mod_socket_remove_keys(int keys[], int length);

#ifdef __cplusplus
}
#endif

#endif