OpenJAUS Software Development Kit
4.3.1
|
This is a brief description. More...
#include <Interface.h>
Inherited by openjaus::transport::AS5669::JtcpInterface, and openjaus::transport::AS5669::JudpInterface.
Classes | |
class | Callback |
Public Member Functions | |
Interface () | |
virtual | ~Interface () |
Interface (InterfaceSettingsInterface *settings) | |
const std::map< WrapperType, system::PriorityQueue *> & | getRecvQueues () const |
Accessor to get the value of recvQueues. More... | |
uint16_t | getSequenceNumber () const |
Accessor to get the value of sequenceNumber. More... | |
bool | setSequenceNumber (uint16_t sequenceNumber) |
Accessor to set value of sequenceNumber. More... | |
system::PriorityQueue * | getRecvQueue () const |
Accessor to get the value of recvQueue. More... | |
bool | setRecvQueue (system::PriorityQueue *recvQueue) |
Accessor to set value of recvQueue. More... | |
const system::PriorityQueue & | getSendQueue () const |
Accessor to get the value of sendQueue. More... | |
const system::Thread & | getRecvThread () const |
Accessor to get the value of recvThread. More... | |
const system::Thread & | getSendThread () const |
Accessor to get the value of sendThread. More... | |
system::NetworkInterface * | getSubsIf () const |
Accessor to get the value of subsIf. More... | |
bool | setSubsIf (system::NetworkInterface *subsIf) |
Accessor to set value of subsIf. More... | |
system::NetworkInterface * | getNodeIf () const |
Accessor to get the value of nodeIf. More... | |
bool | setNodeIf (system::NetworkInterface *nodeIf) |
Accessor to set value of nodeIf. More... | |
Address * | getAddress () const |
Accessor to get the value of address. More... | |
bool | setAddress (Address *address) |
Accessor to set value of address. More... | |
bool | send (Wrapper *message) |
Operation send. More... | |
bool | open (Address tAddress) |
Operation open. More... | |
bool | close () |
Operation close. More... | |
bool | broadcast (Wrapper message) |
Operation broadcast. More... | |
virtual void | run () |
virtual void | stop () |
bool | setRecvQueue (WrapperType type, system::PriorityQueue *queue) |
Operation setRecvQueue. More... | |
bool | checkAddresses (Wrapper *message) |
Operation checkAddresses. More... | |
virtual std::string | toString () const |
virtual void | addAckNakCallback (void(*callback)(const AckNakEventArgs &args))=0 |
virtual void | addAckNakCallback (void(*callback)(void *object, const AckNakEventArgs &args), void *object)=0 |
virtual void | removeAckNakCallback (void(*callback)(const AckNakEventArgs &args))=0 |
virtual void | removeAckNakCallback (void(*callback)(void *object, const AckNakEventArgs &args), void *object)=0 |
Static Public Member Functions | |
static std::vector< AS5669::JausWrapper * > | splitLargeMessage (Wrapper *wrapper) |
Protected Member Functions | |
virtual void * | recvThreadMethod () |
virtual void * | sendThreadMethod () |
virtual void | sendMessage (Wrapper *wrapper)=0 |
virtual void | handleNakSend (Wrapper *nak) |
Sends a NAK over the interface. More... | |
void | recvLargeMessage (Wrapper *wrapper) |
void | sendLargeMessage (Wrapper *wrapper) |
bool | messageIsForMe (Wrapper *const wrapper) |
virtual bool | sendInternal (Wrapper *message) |
Protected Attributes | |
std::map< WrapperType, system::PriorityQueue *> | recvQueues |
uint16_t | sequenceNumber |
system::PriorityQueue * | recvQueue |
system::PriorityQueue | sendQueue |
system::Thread | recvThread |
system::Thread | sendThread |
system::NetworkInterface * | subsIf |
system::NetworkInterface * | nodeIf |
Address * | address |
std::map< transport::Address, JausLargeMessageBuffer * > | largeMessageMap |
Private Member Functions | |
JausLargeMessageBuffer * | lookupMessageBuffer (Wrapper *const wrapper) |
Private Attributes | |
InterfaceSettingsInterface * | settings |
Friends | |
OPENJAUS_EXPORT friend std::ostream & | operator<< (std::ostream &output, const Interface &object) |
OPENJAUS_EXPORT friend std::ostream & | operator<< (std::ostream &output, const Interface *object) |
Detailed description.
openjaus::transport::Interface::Interface | ( | ) |
|
virtual |
openjaus::transport::Interface::Interface | ( | InterfaceSettingsInterface * | settings | ) |
|
pure virtual |
Implemented in openjaus::transport::AS5669::JtcpInterface, and openjaus::transport::AS5669::JudpInterface.
|
pure virtual |
Implemented in openjaus::transport::AS5669::JtcpInterface, and openjaus::transport::AS5669::JudpInterface.
bool openjaus::transport::Interface::broadcast | ( | Wrapper | message | ) |
message |
bool openjaus::transport::Interface::checkAddresses | ( | Wrapper * | message | ) |
message |
bool openjaus::transport::Interface::close | ( | ) |
Address * openjaus::transport::Interface::getAddress | ( | ) | const |
system::NetworkInterface * openjaus::transport::Interface::getNodeIf | ( | ) | const |
system::PriorityQueue * openjaus::transport::Interface::getRecvQueue | ( | ) | const |
const std::map< WrapperType, system::PriorityQueue *> & openjaus::transport::Interface::getRecvQueues | ( | ) | const |
const system::Thread & openjaus::transport::Interface::getRecvThread | ( | ) | const |
const system::PriorityQueue & openjaus::transport::Interface::getSendQueue | ( | ) | const |
const system::Thread & openjaus::transport::Interface::getSendThread | ( | ) | const |
uint16_t openjaus::transport::Interface::getSequenceNumber | ( | ) | const |
system::NetworkInterface * openjaus::transport::Interface::getSubsIf | ( | ) | const |
|
protectedvirtual |
Sends a NAK over the interface. By default, the NAK is not handled is simply deleted.
Reimplemented in openjaus::transport::AS5669::JudpInterface.
|
private |
|
protected |
bool openjaus::transport::Interface::open | ( | Address | tAddress | ) |
tAddress |
|
protected |
|
protectedvirtual |
Reimplemented in openjaus::transport::AS5669::JtcpInterface, and openjaus::transport::AS5669::JudpInterface.
|
pure virtual |
Implemented in openjaus::transport::AS5669::JtcpInterface, and openjaus::transport::AS5669::JudpInterface.
|
pure virtual |
Implemented in openjaus::transport::AS5669::JtcpInterface, and openjaus::transport::AS5669::JudpInterface.
|
virtual |
Reimplemented in openjaus::transport::AS5669::JudpInterface.
bool openjaus::transport::Interface::send | ( | Wrapper * | message | ) |
message |
|
protectedvirtual |
|
protected |
|
protectedpure virtual |
Implemented in openjaus::transport::AS5669::JtcpInterface, and openjaus::transport::AS5669::JudpInterface.
|
protectedvirtual |
Reimplemented in openjaus::transport::AS5669::JtcpInterface, and openjaus::transport::AS5669::JudpInterface.
bool openjaus::transport::Interface::setAddress | ( | Address * | address | ) |
address | The value of the new address. |
bool openjaus::transport::Interface::setNodeIf | ( | system::NetworkInterface * | nodeIf | ) |
nodeIf | The value of the new nodeIf. |
bool openjaus::transport::Interface::setRecvQueue | ( | system::PriorityQueue * | recvQueue | ) |
recvQueue | The value of the new recvQueue. |
bool openjaus::transport::Interface::setRecvQueue | ( | WrapperType | type, |
system::PriorityQueue * | queue | ||
) |
type | |
queue |
bool openjaus::transport::Interface::setSequenceNumber | ( | uint16_t | sequenceNumber | ) |
sequenceNumber | The value of the new sequenceNumber. |
bool openjaus::transport::Interface::setSubsIf | ( | system::NetworkInterface * | subsIf | ) |
subsIf | The value of the new subsIf. |
|
static |
|
virtual |
Reimplemented in openjaus::transport::AS5669::JudpInterface.
|
virtual |
Reimplemented in openjaus::transport::AS5669::JtcpInterface, and openjaus::transport::AS5669::JudpInterface.
|
friend |
|
friend |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
private |
|
protected |