#include <socket.h>
Data Fields | |
const SockVTAB * | vtab |
Socket_Type | type |
char | label [32] |
uint32 | id |
SOCKET | socket |
mstime | created |
mstime | lastmsg |
mstime | timeout |
struct Socket * | active_next |
uint8 * | pOutput |
RingBuff | output |
uint8 * | pInput |
RingBuff | input |
uint8 * | pAppHeap |
ctl_heap | appheap |
void(* | appReceived )(struct Socket *sock, ctl_serial *serial) |
Application callback for packet received. | |
void(* | appDisconnect )(struct Socket *sock) |
Application callback for socket closed. |
Definition at line 84 of file socket.h.
const SockVTAB* Socket::vtab |
Virtual function table - what to do with this
Definition at line 86 of file socket.h.
Referenced by Socket_Close(), Socket_Create_Client(), Socket_Create_Listener(), Socket_Create_Login(), Socket_Create_Raw(), and Socket_Create_User().
An identifiable type for socket
Definition at line 87 of file socket.h.
Referenced by Socket_Close(), Socket_Create(), Socket_Create_Client(), Socket_Create_Listener(), Socket_Create_Login(), Socket_Create_Raw(), and Socket_Create_User().
char Socket::label[32] |
Make this a little more traceable/debuggable
Definition at line 88 of file socket.h.
Referenced by Socket_Alloc_Serial(), Socket_Close(), Socket_Create(), Socket_Create_Client(), Socket_Create_Listener(), Socket_Create_Login(), Socket_Create_Raw(), Socket_Create_User(), Socket_Write(), and Socket_Write_Serial().
uint32 Socket::id |
Socket ID; index of socket and sequence number
Definition at line 89 of file socket.h.
Referenced by Socket_Close(), Socket_Create(), SocketID(), and SocketLut().
SOCKET Socket::socket |
Actual socket handle
Definition at line 90 of file socket.h.
Referenced by Socket_Close(), Socket_Create(), Socket_Create_Listener(), and Socket_Create_Login().
mstime Socket::created |
mstime Socket::lastmsg |
mstime Socket::timeout |
How long to wait before closing an inactive connection, or 0
Definition at line 93 of file socket.h.
Referenced by Socket_Create(), Socket_Create_Client(), Socket_Create_Listener(), Socket_Create_Login(), Socket_Create_Raw(), and Socket_Create_User().
struct Socket* Socket::active_next [read] |
uint8* Socket::pOutput |
RingBuff Socket::output |
Output buffer
Definition at line 114 of file socket.h.
Referenced by Socket_Alloc_Serial(), Socket_Customize(), Socket_Write(), and Socket_Write_Serial().
uint8* Socket::pInput |
RingBuff Socket::input |
Input buffer
Definition at line 122 of file socket.h.
Referenced by Socket_Customize(), and Socket_Raw_Consume().
uint8* Socket::pAppHeap |
A heap for application to stuff things into this
Definition at line 128 of file socket.h.
Referenced by Socket_Customize().
void(* Socket::appReceived)(struct Socket *sock, ctl_serial *serial) |
Application callback for packet received.
sock | This instance | |
serial | Serial data containing the packet; rewind it for the length or to re-use (broadcast) it |
Referenced by Socket_Close(), and Socket_Create().
void(* Socket::appDisconnect)(struct Socket *sock) |
Application callback for socket closed.
sock | This instance |
Referenced by Socket_Close(), and Socket_Create().