X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=bertos%2Fnet%2Ftcp_socket.h;fp=bertos%2Fnet%2Ftcp_socket.h;h=74ca1074e8209c0c8cde5270da83540fb676b077;hb=91ed9541e2598d8edfe1a5eaa5908760ea1edb4c;hp=0791c187864ba3cd4910f3f4b637ce96781cee49;hpb=e8b0472be10fba4ca6baa62d8d483db90e28c06e;p=bertos.git diff --git a/bertos/net/tcp_socket.h b/bertos/net/tcp_socket.h index 0791c187..74ca1074 100644 --- a/bertos/net/tcp_socket.h +++ b/bertos/net/tcp_socket.h @@ -48,16 +48,16 @@ typedef struct TcpSocket { - KFile fd; - struct netconn *sock; - struct netbuf *rx_buf_conn; - size_t remaning_data_len; + KFile fd; ///< KFile context. + struct netconn *sock; ///< Current sockect connection pointer. + struct netbuf *rx_buf_conn; ///< Current received buffer from socket. + size_t remaning_data_len; ///< Number of bytes to read from the received buffer. - struct ip_addr *local_addr; - struct ip_addr *remote_addr; - uint16_t port; + struct ip_addr *local_addr; ///< Device Ip. + struct ip_addr *remote_addr; ///< Ip address which we want to connect. + uint16_t port; ///< Number port to connect. - int error; + int error; ///< Error status. } TcpSocket; #define KFT_TCPSOCKET MAKE_ID('T', 'S', 'C', 'K')