Reference

Wireless Class Reference

#include <Wireless.h>

Detailed Description

Tekkotsu wireless class.

For more information on using wireless, please read the following tutorials:

TekkotsuMon
TCP/IP
Remote Processing OPENR Tekkotsu Wireless and Remote Processing OPENR provide different interfaces to comparable wireless functionality.

Definition at line 26 of file Wireless.h.

Public Member Functions

Wireless ()

constructor - only one wireless object is required per Aperios process.

~Wireless ()

destructor

int listen (int sock, int port)

The socket waits for incoming connections.

int connect (int sock, const char *ipaddr, int port)

The socket tries to connect to a specific.

void setReceiver (int sock, int(*rcvcbckfn)(char *, int))

sets receiver callback for a socket

void setDaemon (int sock, bool val=true)

sets the socket to be a daemon (recycles on close)

void close (int sock)

closes and destroys non server, daemon sockets

Socket * socket (TransportType_t ttype)

Creates a new socket.

Socket * socket (TransportType_t ttype, int recvsize, int sendsize)

bool isConnected (int sock)

utility function that you can use if you're curious about the state of the socket.

bool isReady (int sock)

utility function that you can use if you're curious about the state of the socket.

bool hasData (int sock)

utility function that you can use if you're curious about the state of the socket.

void setReceiver (Socket &sobj, int(*rcvcbckfn)(char *, int))

helper function for the function with the same name that takes a socket descriptor (int)

void setReceiver (Socket *sobj, int(*rcvcbckfn)(char *, int))

helper function for the function with the same name that takes a socket descriptor (int)

void setDaemon (Socket &sobj, bool val=true)

helper function for the function with the same name that takes a socket descriptor (int)

void setDaemon (Socket *sobj, bool val=true)

helper function for the function with the same name that takes a socket descriptor (int)

int listen (Socket &sobj, int port)

helper function for the function with the same name that takes a socket descriptor (int)

int listen (Socket *sobj, int port)

helper function for the function with the same name that takes a socket descriptor (int)

int connect (Socket &sobj, const char *ipaddr, int port)

helper function for the function with the same name that takes a socket descriptor (int)

int connect (Socket *sobj, const char *ipaddr, int port)

helper function for the function with the same name that takes a socket descriptor (int)

void close (Socket &sobj)

helper function for the function with the same name that takes a socket descriptor (int)

void close (Socket *sobj)

helper function for the function with the same name that takes a socket descriptor (int)

void receive (int sock, int(*rcvcbckfn)(char *, int))

function for internal and Socket use. You should not call this

void receive (int sock)

function for internal and Socket use. You should not call this

void send (int sock)

void blockingSend (int sock)

void ListenCont (void *msg)

void BindCont (void *msg)

void ConnectCont (void *msg)

void SendCont (void *msg)

void ReceiveCont (void *msg)

void CloseCont (void *msg)

Static Public Attributes

const int WIRELESS_MAX_SOCKETS = 100

Maximum number of sockets which can be created.

const int WIRELESS_DEF_RECV_SIZE = 1024

Default number of bytes to use for receive buffers (overridden by value passed to socket()).

const int WIRELESS_DEF_SEND_SIZE = 1024

Default number of bytes to use for send buffers (overridden by value passed to socket()).

Private Member Functions

Wireless (const Wireless &)

don't call

Wireless & operator= (const Wireless &)

don't call

Private Attributes

antStackRef ipstackRef

private ALOKL_TODO

OID myOID

private ALOKL_TODO

Socket * sockets [WIRELESS_MAX_SOCKETS]

private ALOKL_TODO

list< int > freeSockets

private ALOKL_TODO

Constructor & Destructor Documentation

Wireless::Wireless ( )

constructor - only one wireless object is required per Aperios process.
MMCombo already creates one. The (global) instance is called wireless, and you can access it by including Wireless/Wireless.h (this file) in your code
Definition at line 17 of file Wireless.cc.
References freeSockets, ipstackRef, myOID, sockets, and WIRELESS_MAX_SOCKETS.

Wireless::~Wireless ( )

destructor

Definition at line 30 of file Wireless.cc.

Wireless::Wireless ( const Wireless & ) [private]

don't call

Member Function Documentation

void Wireless::BindCont ( void * msg )

callback function for communicating with Aperios Networking Toolkit. You should not call this.
Definition at line 196 of file Wireless.cc.
References SocketNS::CONNECTION_CONNECTED, SocketNS::CONNECTION_ERROR, sockets, and Socket::state.

void Wireless::blockingSend ( int sock )

Bug:
This doesn't actually seem to block until the message is fully sent... a crash immediately after this will still cause a line or two to be dropped. This is still less dropped than regular send, but doesn't do much good for debugging until we fix this. (if we can...)

Definition at line 249 of file Wireless.cc.
References SocketNS::CONNECTION_CONNECTED, ipstackRef, Socket::sendSize, sockets, Socket::state, Socket::tx, and WIRELESS_MAX_SOCKETS.

void Wireless::close ( Socket * sobj ) [inline]

helper function for the function with the same name that takes a socket descriptor (int)

Definition at line 99 of file Wireless.h.
References close(), and Socket::sock.