Carapace

CommsInfo Class

CommsInfo Creation

A CommsInfo object is usually created by calling the info method on a CommsStack or one of the comms modules.

The create function can be used to create a CommsInfo object eg.

    (create CommsInfo)

CommsInfo Properties

A CommsInfo object supports the following properties:

property name property type description
isConnecting Object holds true if the module is connecting, and the empty list () otherwise
isConnected Object holds true if the module is connected, and the empty list () otherwise
isDisconnecting Object holds true if the module is disconnecting, and the empty list () otherwise
isListening Object holds true if the module is listening for new connections, and the empty list () otherwise
isBound Object holds true if the module is bound to a particular address, and the empty list () otherwise
bytesSent Integer the number of bytes sent by the module
bytesReceived Integer the number of bytes received by the module
packetsSent Integer the number of packets sent by the module
packetsReceived Integer the number of packets received by the module
timeSinceSent Integer time (in seconds) since the last data was sent through the module
timeSinceReceived Integer time (in seconds) since the last data was received through the module
idle Integer time (in seconds) that this module has been idle ie. the time since any data has been sent or received using this module

CommsInfo Methods

None.


Contents Index Current topic: communications Related topics: communications classes, objects