Include/vos_sockMgr.h

   1 /******************************************************************************
   2 ###############################################################################
   3 #   Copyright (c) [2017-2020] [ICT/CAS]                                        #
   4 #   Licensed under the ORAN Software License v1.0 (License)             #
   5 ###############################################################################
   6 ******************************************************************************/
   7
   8
   9
  10 #ifndef __VOS_SOCKMGR_H__
  11 #define __VOS_SOCKMGR_H__
  12
  13 #include "vos_types.h"
  14 #include "vos_timer.h"
  15 #include "vos_que.h"
  16 #include "vos_socket.h"
  17 #include "vos_module.h"
  18
  19 #define COMM_SCTP_ADDR_MAX 5
  20
  21
  22 #define VOS_SOCKET_MSG_MAX 9000
  23
  24
  25 /** 采用socket mgr 需要提供的handle函数，用于接收数据
  26  * @param[in ]   buf         用于消息接收的缓冲区
  27  * @param[in ]   size        buf 大小
  28  * @param[in ]   opval       额外信息，类型为 vos_mod_com_op_t
  29  * @param[in ]   opvalLen    opval的大小
  30  *
  31 */
  32 typedef LONG (*receive_handler)(VOID *buf,LONG size,VOID *opval,LONG opvalLen);
  33
  34
  35 /** tcp/sctp one-to-one 用于接收客户端accept 事件的函数
  36 * @param[in ]   info           客户端信息，实际为vos_sock_info_t
  37 * @param[in ]   infoLen        信息长度
  38 *
  39 */
  40 typedef LONG (*accept_handler)(VOID *info,LONG infoLen);
  41
  42
  43 typedef struct sctp_para_s {
  44     vos_sockaddr_t                  addrs[COMM_SCTP_ADDR_MAX];  ///< ip 地址
  45     LONG                            addrsCnt;                   ///< ip 个数
  46     struct sctp_sndrcvinfo          sinfo;                      ///< sctp_sndrcvinfo
  47     struct sctp_initmsg             initmsg;                    ///< sctp_initmsg
  48     struct sctp_event_subscribe     events;                     ///< sctp_event_subscribe
  49 }sctp_para_t;
  50
  51 typedef union {
  52         vos_sockaddr_t   addr;
  53         sctp_para_t      sctp;
  54 }___addr_u;
  55
  56 /** 创建socket需要提供的参数 */
  57 typedef struct vos_sock_para_s
  58 {
  59     module_comm_type_t type;                ///< 通信方式
  60     union{
  61         vos_sockaddr_t addr;                ///< socket 通信
  62         sctp_para_t    sctp;                ///< sctp   通信
  63     }u;
  64     ___addr_u          client_bind_addr;    ///< 创建客户端时如果也需要绑定地址，填写该变量
  65     receive_handler  recv_handle;           ///< 接收函数
  66     accept_handler   accept_handle;         ///< 接收accept 事件
  67     LONG             maxClient;             ///< tcp server 允许的连接数
  68     BOOL             soloMode;              ///< 如果为真，则单独创建接收线程；如果为假，则由 VOS socket代理任务负责接收
  69     LONG             fdIdx;                 ///< 无需关心
  70 }vos_sock_para_t;
  71
  72 typedef struct vos_sock_info_s{
  73     module_comm_type_t type;     ///< 通信方式
  74     LONG fd;                     ///< socket
  75     LONG fdIdx;                  ///< 无需关心
  76     LONG c_flag;                 ///< 无需关心
  77     struct sctp_sndrcvinfo sri;  ///< sctp_recvmsg()/sctp_send() 中的 sinfo,sctp_sendmsg() 中ppid,flags,stream_no,timetolive,context也从该结构中获得
  78     LONG msg_flags;              ///< sctp_recvmsg() 中的 msg_flags
  79     vos_sockaddr_t addr;         ///< udp/sctp one-to-many 接收到的对端地址，同时也是udp/sctp one-to-many 发送的目的地址
  80 }vos_sock_info_t;
  81
  82
  83 /**
  84  * 创建socket通信
  85  * @param[in ]   name         模块名，大小为 MODULE_NAME_LEN
  86  * @param[in ]   pPara        额外参数数组
  87  * @param[in ]   size         数组大小
  88  * @param[out]   info           socket 相关信息，用于发送消息和删除该socket
  89  * @return       VOS_OK - 成功，其他 - 失败
  90  */
  91 LONG VOS_SOCKET_create(const CHAR *name,vos_sock_para_t *pPara,LONG size,vos_sock_info_t *info);
  92
  93
  94 /**
  95  * 删除 socket
  96  * @param[in ]   info           创建时获得的socket 相关信息
  97  * @return       VOS_OK - 成功，其他 - 失败
  98  */
  99 LONG VOS_SOCKET_delete(vos_sock_info_t *info);
 100
 101
 102 /**
 103  * 判断是否连接成功(只判断tcp 和sctp one-to-one 是否connect成功)
 104  * @param[in ]   info           创建时获得的socket 相关信息
 105  * @return       连接正常返回 VOS_TRUE,否则返回 VOS_FALSE
 106  */
 107 BOOL VOS_SOCKET_isLink(vos_sock_info_t *info);
 108
 109
 110 /**
 111  * socket 发送数据
 112  * @param[in ]   info           socket 相关信息
 113  * @param[in ]   msgData        数据
 114  * @param[in ]   msgDataLen     数据长度
 115  * @return       成功返回 发送的字节数 ，失败则返回 VOS_ERROR
 116  */
 117 LONG VOS_SOCKET_send(vos_sock_info_t *info,VOID *msgData,LONG msgDataLen);
 118
 119
 120
 121 #endif /* __VOS_SOCKMGR_H__ */