From 48e47110397c894716525db219e53300c08f64dd Mon Sep 17 00:00:00 2001
From: jimi-wzq <wangzhengquan85@gmail.com>
Date: 星期二, 12 一月 2021 15:27:34 +0800
Subject: [PATCH] doxygen
---
src/socket/net_mod_socket_wrapper.cpp | 111 ++++++++++++++++++++++++++++++++-----------------------
1 files changed, 64 insertions(+), 47 deletions(-)
diff --git a/src/socket/net_mod_socket_wrapper.cpp b/src/socket/net_mod_socket_wrapper.cpp
index bf83e72..e9a8adf 100644
--- a/src/socket/net_mod_socket_wrapper.cpp
+++ b/src/socket/net_mod_socket_wrapper.cpp
@@ -8,8 +8,7 @@
*/
void * net_mod_socket_open() {
printf("=====net_mod_socket_open\n");
- net_mod_socket_t *sockt = (net_mod_socket_t *)malloc(sizeof(net_mod_socket_t));
- sockt->sockt = new NetModSocket;
+ NetModSocket *sockt = new NetModSocket;
return (void *)sockt;
}
@@ -18,9 +17,8 @@
*/
void net_mod_socket_close(void *_socket) {
printf("====net_mod_socket_close\n");
- net_mod_socket_t *sockt = (net_mod_socket_t *)_socket;
- delete sockt->sockt;
- free(sockt);
+ NetModSocket *sockt = (NetModSocket *)_socket;
+ delete sockt;
}
@@ -30,8 +28,8 @@
* @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);
+ NetModSocket *sockt = (NetModSocket *)_socket;
+ return sockt->bind(port);
}
/**
@@ -39,8 +37,8 @@
* @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);
+ NetModSocket *sockt = (NetModSocket *)_socket;
+ return sockt->force_bind(port);
}
/**
* 鍙戦�佷俊鎭�
@@ -48,18 +46,18 @@
* @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);
+ NetModSocket *sockt = (NetModSocket *)_socket;
+ return 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);
+ NetModSocket *sockt = (NetModSocket *)_socket;
+ return 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);
+ NetModSocket *sockt = (NetModSocket *)_socket;
+ return sockt->sendto_nowait(buf, size, port);
}
/**
@@ -68,17 +66,17 @@
* @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);
+ NetModSocket *sockt = (NetModSocket *)_socket;
+ return 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);
+ NetModSocket *sockt = (NetModSocket *)_socket;
+ return 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);
+ NetModSocket *sockt = (NetModSocket *)_socket;
+ return sockt->recvfrom_nowait(buf, size, port);
}
@@ -93,10 +91,29 @@
* 浼樼偣锛�1鏌愪釜鑺傜偣鐨勬晠闅滀笉浼氶樆濉炲叾浠栬妭鐐广��2鎬ц兘濂�
* 缂虹偣锛氫笉鏄嚎绋嬪畨鍏ㄧ殑, 鍗充笉鑳芥湁涓や釜浠ヤ笂鐨勭嚎绋嬪悓鏃朵娇鐢ㄨ繖涓璞＄殑鏂规硶
*/
+
+
+//*****************************************************************************
+//
+//! \brief Write one byte to special register
+//!
+//! This function is to write one byte to LIS302DL register,one byte will be
+//! writen in appointed address.
+//!
+//! \param node_arr specifies the target register address.
+//! \param send_buf is the data written to target register.
+//!
+//! \return Indicate the status of operation which can be one of the following
+//! value \b SUCCESS or \b FAILURE .
+//!
+//! \note This function is used by internal, user MUST NOT call it in your
+//! Application.
+//
+//*****************************************************************************
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);
+ NetModSocket *sockt = (NetModSocket *)_socket;
+ return sockt->sendandrecv(node_arr, arrlen, send_buf, send_size, recv_arr, recv_arr_size);
}
/**
* 濡傛灉寤虹珛杩炴帴鐨勮妭鐐规病鏈夋帴鍙楀埌娑堟伅绛夊緟timeout鐨勬椂闂村悗杩斿洖
@@ -104,14 +121,14 @@
*/
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);
+ NetModSocket *sockt = (NetModSocket *)_socket;
+ return 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);
+ NetModSocket *sockt = (NetModSocket *)_socket;
+ return sockt->sendandrecv_nowait(node_arr, arrlen, send_buf, send_size, recv_arr, recv_arr_size);
}
@@ -124,16 +141,16 @@
* @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);
+ NetModSocket *sockt = (NetModSocket *)_socket;
+ return 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);
+ NetModSocket *sockt = (NetModSocket *)_socket;
+ return 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);
+ NetModSocket *sockt = (NetModSocket *)_socket;
+ return sockt->pub_nowait(node_arr, node_arr_len, topic, topic_size, content, content_size);
}
@@ -147,17 +164,17 @@
* @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, SHM_BUS_KEY);
+ NetModSocket *sockt = (NetModSocket *)_socket;
+ return sockt->sub((char *)topic, size, SHM_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, SHM_BUS_KEY, sec, nsec);
+ NetModSocket *sockt = (NetModSocket *)_socket;
+ return sockt->sub_timeout((char *)topic, size, SHM_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, SHM_BUS_KEY);
+ NetModSocket *sockt = (NetModSocket *)_socket;
+ return sockt->sub_nowait((char *)topic, size, SHM_BUS_KEY);
}
@@ -168,17 +185,17 @@
* @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, SHM_BUS_KEY);
+ NetModSocket *sockt = (NetModSocket *)_socket;
+ return sockt->desub((char *)topic, size, SHM_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, SHM_BUS_KEY, sec, nsec);
+ NetModSocket *sockt = (NetModSocket *)_socket;
+ return sockt->desub_timeout((char *)topic, size, SHM_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, SHM_BUS_KEY);
+ NetModSocket *sockt = (NetModSocket *)_socket;
+ return sockt->desub_nowait((char *)topic, size, SHM_BUS_KEY);
}
@@ -187,8 +204,8 @@
* 鑾峰彇soket绔彛鍙�
*/
int net_mod_socket_get_key(void * _socket) {
- net_mod_socket_t *sockt = (net_mod_socket_t *)_socket;
- return sockt->sockt->get_key();
+ NetModSocket *sockt = (NetModSocket *)_socket;
+ return sockt->get_key();
}
--
Gitblit v1.8.0