Free Electron
Public Member Functions | List of all members
fe::ext::MessageReliableUDPI Class Referenceabstract

Message Sender/Receiver multi-packet reliable over UDP. More...

#include <MessageReliableUDPI.h>

Inheritance diagram for fe::ext::MessageReliableUDPI:
Inheritance graph
[legend]

Public Member Functions

virtual bool start (uint16_t receivePort)=0
 Start receive and transmit thread and initialize the receive port (0 = open port) More...
 
virtual uint16_t getReceivePort ()=0
 Returns the selected receive port. More...
 
virtual void shutdown ()=0
 Shutdown receive and transmit thread and the message systems. More...
 
virtual bool recvReliableFrom (uint8_t **msg, uint32_t &msgSize, char *fromIPaddress)=0
 Check to see if a message has been received. The receiver is responsible for deleting the message. More...
 
virtual bool sendReliableTo (const uint8_t *msg, const uint32_t msgSize, const char *ipAddress, uint16_t port)=0
 Send a reliable message over UDP to the address and port given. More...
 
- Public Member Functions inherited from fe::Component
const Stringname (void) const
 Return the components chosen name. More...
 
const String verboseName (void) const
 Return the annotated chosen name. More...
 
void setName (const String &name)
 Rename the component to anything you want. More...
 
hp< Registryregistry (void) const
 Get the Registry that created this component. More...
 
void adjoin (sp< Component > spComponent)
 Tie this component's lifetime to another. More...
 
sp< Componentcreate (const String &implementation, BWORD quiet=FALSE) const
 Convienience function to registry()->create() More...
 
void disjoin (void)
 Untie component from Hub, if connected. More...
 
String factoryName (void)
 
void setLibrary (sp< Library > spLibrary)
 Store a reference to the library used to instantiate this component. More...
 
sp< Librarylibrary (void)
 Get the library that created the component. More...
 
void setFactoryIndex (I32 a_factoryIndex)
 Set the library's factory index. More...
 
I32 factoryIndex (void)
 Get the library's factory index. More...
 
void setSingleton (BWORD set)
 Specify whether component is a singleton. More...
 
BWORD isSingleton (void)
 Return whether component is a singleton. More...
 
virtual void acquire (void)
 Specialized reference increment. More...
 
virtual void release (void)
 Specialized reference decrement. More...
 
- Public Member Functions inherited from fe::Handled< Component >
const hp< Component > & getHandle (void) const
 Get a safe handle to this object. More...
 
- Public Member Functions inherited from fe::Protectable
virtual I32 protection (void) const
 
virtual void protect (void)
 
virtual void unprotect (void)
 
virtual Protectableclone (Protectable *pInstance=NULL)
 
- Public Member Functions inherited from fe::Counted
virtual void acquire (int &rCount)
 Increment the reference count (and get the count) More...
 
virtual void abandon (void)
 Decrement the reference count. More...
 
int count (void) const
 Return the count of references. More...
 
void setName (const String &)
 
void trackReference (void *pReference, String what)
 
void untrackReference (void *pReference)
 
void registerRegion (void *pT, U32 bytes)
 
- Public Member Functions inherited from fe::Initialized
void initializeAll (void)
 
void setActive (bool a_active)
 

Additional Inherited Members

- Static Public Member Functions inherited from fe::Counted
static String reportTracker (void)
 
static U32 trackerCount (void)
 
- Protected Types inherited from fe::Initialized
typedef void(* InitializeFunction) (Initialized *)
 
- Protected Member Functions inherited from fe::Handled< Component >
void abandonHandle (void)
 
- Protected Member Functions inherited from fe::Counted
int releaseInternal (void)
 Decrement the reference count. More...
 
void suppressReport (void)
 
- Protected Member Functions inherited from fe::Initialized
void addInitializer (InitializeFunction function)
 

Detailed Description

Message Sender/Receiver multi-packet reliable over UDP.

Member Function Documentation

◆ getReceivePort()

virtual uint16_t fe::ext::MessageReliableUDPI::getReceivePort ( )
pure virtual

Returns the selected receive port.

Implemented in fe::ext::MessageReliableUDP.

◆ recvReliableFrom()

virtual bool fe::ext::MessageReliableUDPI::recvReliableFrom ( uint8_t **  msg,
uint32_t &  msgSize,
char *  fromIPaddress 
)
pure virtual

Check to see if a message has been received. The receiver is responsible for deleting the message.

Implemented in fe::ext::MessageReliableUDP.

◆ sendReliableTo()

virtual bool fe::ext::MessageReliableUDPI::sendReliableTo ( const uint8_t *  msg,
const uint32_t  msgSize,
const char *  ipAddress,
uint16_t  port 
)
pure virtual

Send a reliable message over UDP to the address and port given.

Implemented in fe::ext::MessageReliableUDP.

◆ shutdown()

virtual void fe::ext::MessageReliableUDPI::shutdown ( )
pure virtual

Shutdown receive and transmit thread and the message systems.

Implemented in fe::ext::MessageReliableUDP.

◆ start()

virtual bool fe::ext::MessageReliableUDPI::start ( uint16_t  receivePort)
pure virtual

Start receive and transmit thread and initialize the receive port (0 = open port)

Implemented in fe::ext::MessageReliableUDP.


The documentation for this class was generated from the following file: