xc
Public Member Functions | List of all members
XC::TCP_SocketNoDelay Class Reference

TCP_SocketNoDelay is a sub-class of channel. More...

#include <TCP_SocketNoDelay.h>

Inheritance diagram for XC::TCP_SocketNoDelay:
Inheritance graph
[legend]
Collaboration diagram for XC::TCP_SocketNoDelay:
Collaboration graph
[legend]

Public Member Functions

 TCP_SocketNoDelay (unsigned int)
 
 TCP_SocketNoDelay (unsigned int other_Port, char *other_InetAddr)
 
virtual int setUpShadow (void)
 
virtual int setUpActor (void)
 
int setNextAddress (const ChannelAddress &otherChannelAddress)
 A method invoked to set specify the next address that the next messages to be sent if {sendMessage()} or received if {recvMessage()} is invoked with a null pointer. More...
 
virtual ChannelAddressgetLastSendersAddress (void)
 
int sendObj (MovableObject &theObject, FEM_ObjectBroker &, ChannelAddress *theAddress=0)
 
int recvObj (MovableObject &theObject, FEM_ObjectBroker &, ChannelAddress *theAddress=0)
 
int recvMsg (Message &, ChannelAddress *theAddress=0)
 
int sendMsg (const Message &, ChannelAddress *theAddress=0)
 
int sendMatrix (const Matrix &theMatrix, ChannelAddress *theAddress=0)
 
int recvMatrix (Matrix &theMatrix, ChannelAddress *theAddress=0)
 
int sendVector (const Vector &theVector, ChannelAddress *theAddress=0)
 
int recvVector (Vector &theVector, ChannelAddress *theAddress=0)
 
int sendID (const ID &theID, ChannelAddress *theAddress=0)
 
int recvID (ID &theID, ChannelAddress *theAddress=0)
 
unsigned int getPortNumber (void) const
 
std::string addToProgram (void)
 When creating remote actors the channels created in the actor space need to know how to contact the shadows channels. More...
 
- Public Member Functions inherited from XC::Channel
 Channel (CommandEntity *owr=nullptr)
 Constructor.
 
virtual int setUpConnection (void)=0
 
virtual bool isDatastore (void) const
 Return true if channel is a data store.
 
virtual int getDbTag (void) const
 Return next available database tag. More...
 
bool checkDbTag (const int &dbTag)
 Check if a dbTag is already used.
 
const IDgetUsedTags (void) const
 Return the list of dbTags already used.
 
void clearDbTags (void)
 Reset used database tags set.
 
int getTag (void) const
 Return the object tag.
 
virtual int sendObj (int commitTag, MovableObject &theObj, ChannelAddress *theAddress=nullptr)=0
 To send the object theObj and the commit tag commitTag to a remote Channel whose address is given by theAddress. More...
 
virtual int recvObj (int commitTag, MovableObject &theObj, FEM_ObjectBroker &theBroker, ChannelAddress *theAddress=nullptr)=0
 To receive the object theObj with the commit tag commitTag from a remote Channel whose address is given by theAddress. More...
 
template<class inputIterator >
int sendObjs (int commitTag, const inputIterator &first, const inputIterator &last, ChannelAddress *theAddress=nullptr)
 Send the objects on interval [first,last).
 
template<class inputIterator >
int recvObjs (int commitTag, const inputIterator &first, const inputIterator &last, FEM_ObjectBroker &, ChannelAddress *theAddress=nullptr)
 Receive an object sequence.
 
virtual int sendMsg (int dbTag, int commitTag, const Message &theMsg, ChannelAddress *theAddress=nullptr)=0
 A method invoked to send the data in the Message object theMsg to another Channel object. More...
 
virtual int recvMsg (int dbTag, int commitTag, Message &theMsg, ChannelAddress *theAddress=nullptr)=0
 Invoked to send the data in the Message object theMsg to another Channel object. More...
 
virtual int sendMatrix (int dbTag, int commitTag, const Matrix &theMatrix, ChannelAddress *theAddress=nullptr)=0
 Invoked to receive the data in the Matrix object theMatrix to another Channel object. More...
 
virtual int recvMatrix (int dbTag, int commitTag, Matrix &theMatrix, ChannelAddress *theAddress=nullptr)=0
 Invoked to receive the data in the Matrix object theMatrix to another Channel object. More...
 
virtual int sendVector (int dbTag, int commitTag, const Vector &theVector, ChannelAddress *theAddress=nullptr)=0
 Invoked to receive the data in the Vector object theVector to another Channel object. More...
 
virtual int recvVector (int dbTag, int commitTag, Vector &theVector, ChannelAddress *theAddress=nullptr)=0
 Invoked to receive the data in the Vector object theVector to another Channel object. More...
 
virtual int sendID (int dbTag, int commitTag, const ID &theID, ChannelAddress *theAddress=nullptr)=0
 Invoked to receive the data in the ID object theID to another Channel object. More...
 
virtual int recvID (int dbTag, int commitTag, ID &theID, ChannelAddress *theAddress=nullptr)=0
 Invoked to receive the data in the ID object theID to another Channel object. More...
 
- Public Member Functions inherited from CommandEntity
 CommandEntity (CommandEntity *owr=nullptr)
 Default constructor.
 
CommandEntityOwner (void)
 Return a pointer to the object owner.
 
const CommandEntityOwner (void) const
 Return un puntero al objeto propietario de ESTE.
 
const StandardOutputWrappergetStandardOutputWrapper (void) const
 Return the regular output stream wrapper.
 
StandardOutputWrappergetStandardOutputWrapper (void)
 Return the regular output stream wrapper.
 
const std::string & getLogFileName (void) const
 Returns log file name.
 
void setLogFileName (const std::string &)
 Sets log file name.
 
const std::string & getErrFileName (void) const
 Returns err file name.
 
void setErrFileName (const std::string &)
 Sets error file name.
 
const std::string & getOutputFileName (void) const
 Returns regular output file name.
 
void setOutputFileName (const std::string &)
 Sets regular output file name.
 
boost::python::object evalPy (boost::python::object dict, const std::string &)
 Return the Python object that results from evaluating the argument.
 
boost::python::object execPy (boost::python::object dict, const std::string &)
 Return the Python objects that results from executing the code in the string argument.
 
boost::python::object execFilePy (boost::python::object dict, const std::string &)
 Return the Python object that results from executing the code in the file.
 
- Public Member Functions inherited from EntityWithProperties
 EntityWithProperties (EntityWithProperties *owr=nullptr)
 Default constructor.
 
virtual bool operator== (const EntityWithProperties &) const
 Comparison operator.
 
void clearPyProps (void)
 Clear python properties map.
 
bool hasPyProp (const std::string &)
 Returns true if property exists.
 
boost::python::object getPyProp (const std::string &str)
 Return the Python object with the name being passed as parameter.
 
void setPyProp (std::string str, boost::python::object val)
 Sets/appends a value tho the Python object's dictionary.
 
void copyPropsFrom (const EntityWithProperties &)
 Copy the properties from the argument.
 
boost::python::list getPropNames (void) const
 Return the names of the object properties weightings.
 
const PythonDict & getPropertiesDict (void) const
 Return a std::map container with the properties of the object.
 
boost::python::dict getPyDict (void) const
 Return a Python dictionary containing the object members values.
 
void setPyDict (const boost::python::dict &)
 Set the values of the object members from a Python dictionary.
 
- Public Member Functions inherited from EntityWithOwner
 EntityWithOwner (EntityWithOwner *owr=nullptr)
 Default constructor.
 
 EntityWithOwner (const EntityWithOwner &)
 Copy constructor.
 
EntityWithOwneroperator= (const EntityWithOwner &)
 Assignment operator.
 
virtual bool operator== (const EntityWithOwner &) const
 Comparison operator.
 
virtual ~EntityWithOwner (void)
 Virtual destructor.
 
virtual std::string getClassName (void) const
 Returns demangled class name.
 
void set_owner (EntityWithOwner *owr)
 Assigns the owner of the object.
 
EntityWithOwnerOwner (void)
 
const EntityWithOwnerOwner (void) const
 

Additional Inherited Members

- Public Types inherited from EntityWithProperties
typedef std::map< std::string, boost::python::object > PythonDict
 
- Static Public Member Functions inherited from CommandEntity
static void resetStandardOutput (void)
 Reset the standard output streams to its defaults buffers.
 
- Static Public Member Functions inherited from EntityWithOwner
static int getVerbosityLevel (void)
 Get the value of the verbosity level.
 
static void setVerbosityLevel (const int &)
 Set the value of the verbosity level.
 
- Protected Member Functions inherited from XC::Channel
int sendMovable (int commitTag, MovableObject &)
 Send theObject.
 
int receiveMovable (int commitTag, MovableObject &, FEM_ObjectBroker &)
 Receive theObject.
 
- Protected Member Functions inherited from CommandEntity
template<class T >
void string_to (T &, const std::string &) const
 
- Static Protected Member Functions inherited from CommandEntity
static CommandEntityentcmd_cast (boost::any &data)
 
- Static Protected Attributes inherited from EntityWithOwner
static int verbosity = 1
 Object that owns THIS ONE. More...
 

Detailed Description

TCP_SocketNoDelay is a sub-class of channel.

It is implemented with Berkeley stream sockets using the TCP protocol. Messages delivery is guaranteed. Communication is full-duplex between a pair of connected sockets.

Member Function Documentation

◆ addToProgram()

std::string XC::TCP_SocketNoDelay::addToProgram ( void  )
virtual

When creating remote actors the channels created in the actor space need to know how to contact the shadows channels.

This information is provided in the string returned from this method. It is used by the machine broker when starting the remote process. It places this information as the last arguments to the program.

Implements XC::Channel.

◆ setNextAddress()

int XC::TCP_SocketNoDelay::setNextAddress ( const ChannelAddress theAddress)
virtual

A method invoked to set specify the next address that the next messages to be sent if {sendMessage()} or received if {recvMessage()} is invoked with a null pointer.

Implements XC::Channel.


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