Tekkotsu Homepage | Demos | Overview | Downloads | Dev. Resources | Reference | Credits |
Wireless Class Reference#include <Wireless.h>
Detailed DescriptionTekkotsu wireless class.For more information on using wireless, please read the following tutorials:
The networking interface needs more documentation. It also needs a cleanup. In the mean time, take a look at the TekkotsuMon objects in Tekkotsu Definition at line 35 of file Wireless.h.
Constructor & Destructor Documentation
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 635 of file Wireless.cc.
don't call
Member Function Documentation
Creates a new socket.
Definition at line 790 of file Wireless.cc. Referenced by RemoteRouter::connect(), WorldStateSerializerBehavior::DoStart(), WMMonitorBehavior::DoStart(), WalkControllerBehavior::DoStart(), UPennWalkControllerBehavior::DoStart(), StewartPlatformBehavior::DoStart(), SpeakerServer::DoStart(), MicrophoneServer::DoStart(), HeadPointControllerBehavior::DoStart(), EStopControllerBehavior::DoStart(), Controller::DoStart(), EventLogger::EventLogger(), EventProxy::EventProxy(), LGmixin::LGmixin(), EchoBehavior::processEvent(), EventRouter::serveRemoteEventRequests(), EchoBehavior::setupNetwork(), SegCamBehavior::setupServer(), RegionCamBehavior::setupServer(), and RawCamBehavior::setupServer().
Definition at line 793 of file Wireless.cc.
The socket waits for incoming connections. That is, it acts like a server. If a connection is established and later broken, it resumes waiting for new connections if the socket's daemon flag is set. Definition at line 757 of file Wireless.cc. Referenced by WorldStateSerializerBehavior::DoStart(), WMMonitorBehavior::DoStart(), WalkControllerBehavior::DoStart(), UPennWalkControllerBehavior::DoStart(), StewartPlatformBehavior::DoStart(), SpeakerServer::DoStart(), MicrophoneServer::DoStart(), HeadPointControllerBehavior::DoStart(), EStopControllerBehavior::DoStart(), Controller::DoStart(), EventLogger::EventLogger(), EventProxy::EventProxy(), LGmixin::LGmixin(), listen(), EventRouter::serveRemoteEventRequests(), EchoBehavior::setupNetwork(), SegCamBehavior::setupServer(), RegionCamBehavior::setupServer(), and RawCamBehavior::setupServer().
The socket tries to connect to a specific.
Definition at line 712 of file Wireless.cc. Referenced by connect(), RemoteRouter::connect(), EchoBehavior::processCallback(), and EchoBehavior::processEvent().
sets receiver callback for a socket
Definition at line 675 of file Wireless.cc. Referenced by RemoteRouter::connect(), WMMonitorBehavior::DoStart(), WalkControllerBehavior::DoStart(), UPennWalkControllerBehavior::DoStart(), StewartPlatformBehavior::DoStart(), SpeakerServer::DoStart(), HeadPointControllerBehavior::DoStart(), EStopControllerBehavior::DoStart(), Controller::DoStart(), EventLogger::EventLogger(), EventProxy::EventProxy(), EchoBehavior::processEvent(), EventRouter::serveRemoteEventRequests(), setReceiver(), EchoBehavior::setupNetwork(), SegCamBehavior::setupServer(), and RawCamBehavior::setupServer().
sets receiver callback for a socket, this version requiring the SocketListener interface (more powerful, as this lets us tell connections apart)
Definition at line 679 of file Wireless.cc.
sets the socket to be a daemon (recycles on close)
Definition at line 84 of file Wireless.h. Referenced by SegCamBehavior::closeServer(), RegionCamBehavior::closeServer(), RawCamBehavior::closeServer(), WorldStateSerializerBehavior::DoStart(), WMMonitorBehavior::DoStart(), WalkControllerBehavior::DoStart(), UPennWalkControllerBehavior::DoStart(), StewartPlatformBehavior::DoStart(), SpeakerServer::DoStart(), MicrophoneServer::DoStart(), HeadPointControllerBehavior::DoStart(), EStopControllerBehavior::DoStart(), Controller::DoStart(), WorldStateSerializerBehavior::DoStop(), WMMonitorBehavior::DoStop(), WalkControllerBehavior::DoStop(), UPennWalkControllerBehavior::DoStop(), StewartPlatformBehavior::DoStop(), SpeakerServer::DoStop(), MicrophoneServer::DoStop(), HeadPointControllerBehavior::DoStop(), EStopControllerBehavior::DoStop(), Controller::DoStop(), EventLogger::EventLogger(), EventProxy::EventProxy(), LGmixin::LGmixin(), EventRouter::serveRemoteEventRequests(), setDaemon(), EchoBehavior::setupNetwork(), SegCamBehavior::setupServer(), RegionCamBehavior::setupServer(), RawCamBehavior::setupServer(), EchoBehavior::teardownNetwork(), and EventLogger::~EventLogger().
sets the socket to be a daemon (recycles on close)
Definition at line 86 of file Wireless.h. Referenced by getDaemon().
closes and destroys non server, daemon sockets
Definition at line 683 of file Wireless.cc. Referenced by close(), StewartPlatformBehavior::closeComm(), SegCamBehavior::closeServer(), RegionCamBehavior::closeServer(), RawCamBehavior::closeServer(), SpeakerServer::DoStart(), MicrophoneServer::DoStart(), WorldStateSerializerBehavior::DoStop(), WMMonitorBehavior::DoStop(), WalkControllerBehavior::DoStop(), UPennWalkControllerBehavior::DoStop(), SpeakerServer::DoStop(), MicrophoneServer::DoStop(), HeadPointControllerBehavior::DoStop(), EStopControllerBehavior::DoStop(), Controller::DoStop(), RemoteRouter::processData(), EventRouter::processData(), send(), EchoBehavior::teardownNetwork(), EventLogger::~EventLogger(), EventProxy::~EventProxy(), LGmixin::~LGmixin(), and RemoteRouter::~RemoteRouter().
utility function that you can use if you're curious about the state of the socket. You shouldn't need to use it, since asking sockets for write and read buffers does the necessary sanity checks Definition at line 95 of file Wireless.h. Referenced by SegCamBehavior::closeServer(), RawCamBehavior::closeServer(), Controller::console_callback(), StringInputControl::doReadStdIn(), ControlBase::doReadStdIn(), StewartPlatformBehavior::isConnected(), RemoteEvents::isConnected(), EventLogger::logImage(), EventLogger::logMessage(), EventLogger::logWebcam(), EchoBehavior::processCallback(), WorldStateSerializerBehavior::processEvent(), SegCamBehavior::processEvent(), RegionCamBehavior::processEvent(), RawCamBehavior::processEvent(), MicrophoneServer::processEvent(), EventLogger::processEvent(), EchoBehavior::processEvent(), ConnectionMadeTrans::processEvent(), EventLogger::processStateMachineEvent(), WalkCalibration::refresh(), ValueEditControl< T >::refresh(), ControlBase::refresh(), ConfigurationEditor::NamedEnumerationEditor::refresh(), BatteryCheckControl::refresh(), EchoBehavior::teardownNetwork(), and LGmixin::uploadFile().
utility function that you can use if you're curious about the state of the socket. You shouldn't need to use it, since asking sockets for write and read buffers does the necessary sanity checks Definition at line 98 of file Wireless.h.
utility function that you can use if you're curious about the state of the socket. You shouldn't need to use it, since asking sockets for write and read buffers does the necessary sanity checks Definition at line 102 of file Wireless.h.
utility function that you can use if you're curious about the state of the socket. You shouldn't need to use it, since asking sockets for write and read buffers does the necessary sanity checks Definition at line 103 of file Wireless.h.
helper function for the function with the same name that takes a socket descriptor (int)
Definition at line 108 of file Wireless.h.
helper function for the function with the same name that takes a socket descriptor (int)
Definition at line 110 of file Wireless.h.
helper function for the function with the same name that takes a socket descriptor (int)
Definition at line 112 of file Wireless.h.
helper function for the function with the same name that takes a socket descriptor (int)
Definition at line 114 of file Wireless.h.
helper function for the function with the same name that takes a socket descriptor (int)
Definition at line 116 of file Wireless.h.
helper function for the function with the same name that takes a socket descriptor (int)
Definition at line 117 of file Wireless.h.
helper function for the function with the same name that takes a socket descriptor (int)
Definition at line 118 of file Wireless.h.
helper function for the function with the same name that takes a socket descriptor (int)
Definition at line 119 of file Wireless.h.
helper function for the function with the same name that takes a socket descriptor (int)
Definition at line 120 of file Wireless.h.
helper function for the function with the same name that takes a socket descriptor (int)
Definition at line 121 of file Wireless.h.
helper function for the function with the same name that takes a socket descriptor (int)
Definition at line 122 of file Wireless.h.
helper function for the function with the same name that takes a socket descriptor (int)
Definition at line 124 of file Wireless.h.
helper function for the function with the same name that takes a socket descriptor (int)
Definition at line 126 of file Wireless.h.
helper function for the function with the same name that takes a socket descriptor (int)
Definition at line 127 of file Wireless.h.
helper function for the function with the same name that takes a socket descriptor (int)
Definition at line 128 of file Wireless.h.
There's probably better ways to implement this... (run through the interface list? How does ifconfig do it?) Definition at line 820 of file Wireless.cc.
function for internal and Socket use. You should not call this
function for internal and Socket use. You should not call this
function called by the Socket objects to actually write data to the network. You should not call this. Definition at line 840 of file Wireless.cc. Referenced by blockingSend(), and Socket::flush().
function called by the Socket objects to actually write data to the network. You should not call this. Definition at line 875 of file Wireless.cc. Referenced by Socket::flush().
on non-aperios, set up structures to be checked in pollTest()
Definition at line 911 of file Wireless.cc.
on non-aperios, check to see any network communication has occurred
Definition at line 941 of file Wireless.cc.
on non-aperios, process callbacks and state changes as signaled in pollTest()
Definition at line 948 of file Wireless.cc.
writes del on interruptCtl, breaking out of a pending pollTest() and thus giving an opportunity to change the contents of the FD sets being used;
Definition at line 1150 of file Wireless.cc. Referenced by send().
resets callbackLock to a self-defined lock, which you can request from getCallbackLock() (there's always a callbackLock, the only question is it internally or externally instantiated)
Definition at line 1164 of file Wireless.cc.
private ALOKL_TODO returns the lock to use during all wireless operations (not just callbacks, this is more general) Definition at line 1154 of file Wireless.cc. Referenced by blockingSend(), Socket::flush(), Socket::getWriteBuffer(), Socket::init(), send(), Socket::vprintf(), and Socket::write().
Friends And Related Function Documentation
Definition at line 169 of file Wireless.h.
Member Data Documentation
Maximum number of sockets which can be created.
Definition at line 38 of file Wireless.h. Referenced by blockingSend(), send(), and Wireless().
Default number of bytes to use for receive buffers (overridden by value passed to socket()).
Definition at line 41 of file Wireless.h.
Default number of bytes to use for send buffers (overridden by value passed to socket()).
Definition at line 44 of file Wireless.h.
the maximum number of connections which can be queued when listening
Definition at line 170 of file Wireless.h.
this lock will be aquired during any callbacks which might occur during pollProcess()
Definition at line 179 of file Wireless.h. Referenced by getCallbackLock().
a socket, connected to interruptCtl, which allows pollTest() to be interrupted if new sockets need to be polled
Definition at line 180 of file Wireless.h. Referenced by Wireless().
a socket, connected to interruptChk, which allows pollTest() to be interrupted if new sockets need to be polled
Definition at line 181 of file Wireless.h. Referenced by wakeup(), and Wireless().
a set of file descriptors which should be polled for readable data; set up by pollSetup(), watched (blocking) by pollTest(), and processed by pollProcess()
Definition at line 182 of file Wireless.h. Referenced by pollTest(), and Wireless().
a set of file descriptors which should be polled for write-complete; set up by pollSetup(), watched (blocking) by pollTest(), and processed by pollProcess()
Definition at line 183 of file Wireless.h. Referenced by pollTest(), and Wireless().
a set of file descriptors which should be polled for errors; set up by pollSetup(), watched (blocking) by pollTest(), and processed by pollProcess()
Definition at line 184 of file Wireless.h. Referenced by pollTest(), and Wireless().
maximum file descriptor value in the rfds, wfds, efds fd_set's
Definition at line 185 of file Wireless.h. Referenced by pollTest(), and Wireless().
this lock will be aquired during any callbacks which might occur during pollProcess()
Definition at line 187 of file Wireless.h. Referenced by getDaemon(), hasData(), isConnected(), isError(), isReady(), setDaemon(), and Wireless().
this lock will be aquired during any callbacks which might occur during pollProcess()
Definition at line 188 of file Wireless.h. Referenced by Wireless().
this lock will be aquired during any callbacks which might occur during pollProcess()
Definition at line 189 of file Wireless.h.
The documentation for this class was generated from the following files: |
Tekkotsu v4.0 |
Generated Thu Nov 22 00:58:48 2007 by Doxygen 1.5.4 |