![]() |
helics
2.8.1
|
#include <Endpoint.hpp>
Public Member Functions | |
Endpoint (helics_endpoint hep) HELICS_NOTHROW | |
Endpoint () HELICS_NOTHROW | |
Endpoint (const Endpoint &endpoint) HELICS_NOTHROW | |
Endpoint & | operator= (const Endpoint &endpoint) |
operator helics_endpoint () | |
helics_endpoint | baseObject () const |
bool | isValid () const |
bool | hasMessage () const |
void | setDefaultDestination (const std::string &dest) |
const char * | getDefaultDestination () const |
uint64_t | pendingMessages () const |
Message | getMessage () |
Message | createMessage () |
void | sendMessage (const char *data, size_t data_size) |
void | sendMessage (const std::string &dest, const char *data, size_t data_size) |
void | sendMessage (const char *data, size_t data_size, helics_time time) |
void | sendMessage (const std::string &dest, const char *data, size_t data_size, helics_time time) |
void | sendMessage (const std::string &data) |
void | sendMessage (const std::string &dest, const std::string &data) |
void | sendMessage (const std::string &data, helics_time time) |
void | sendMessage (const std::string &dest, const std::string &data, helics_time time) |
void | sendMessage (const std::vector< char > &data) |
void | sendMessage (const std::string &dest, const std::vector< char > &data) |
void | sendMessage (const std::vector< char > &data, helics_time time) |
void | sendMessage (const std::string &dest, const std::vector< char > &data, helics_time time) |
void | sendMessage (const Message &message) |
void | sendMessageZeroCopy (Message &message) |
const char * | getName () const |
const char * | getType () |
const char * | getInfo () const |
void | setInfo (const std::string &info) |
Class to manage helics endpoint operations
|
inlineexplicit |
construct from a helics_endpoint object
|
inline |
default constructor
|
inline |
copy constructor
|
inline |
get the base helics_endpoint object for use in the c API functions
Referenced by helicscpp::Message::newMessageObject().
|
inline |
create a message object
References helicsEndpointCreateMessageObject().
|
inline |
get the default destination for an endpoint
References helicsEndpointGetDefaultDestination().
|
inline |
get the interface information field of the filter
References helicsEndpointGetInfo().
|
inline |
Get a packet from an endpoint
References helicsEndpointGetMessageObject().
|
inline |
get the name of the endpoint
References helicsEndpointGetName().
|
inline |
get the specified type of the endpoint
References helicsEndpointGetType().
|
inline |
check if the input is valid
References helics_true, and helicsEndpointIsValid().
|
inline |
cast to a helics_endpoint object
|
inline |
Returns the number of pending receives for endpoint
References helicsEndpointPendingMessageCount().
|
inline |
Methods for sending a message send a data block and length
data | pointer to data location |
data_size | the length of the data |
References data, and helicsEndpointSendMessageRaw().
|
inline |
send a data block and length
data | pointer to data location |
data_size | the length of the data |
time | the time to send the message |
References data, and helicsEndpointSendEventRaw().
|
inline |
send a message object
References helicsEndpointSendMessageObject().
|
inline |
send a string to the target destination
data | the information to send |
References data, and helicsEndpointSendMessageRaw().
|
inline |
send a string at a particular time
data | the information to send |
time | the time the message should be delivered |
References data, and helicsEndpointSendEventRaw().
|
inline |
send a data block and length
dest | string name of the destination |
data | pointer to data location |
data_size | the length of the data |
References data, and helicsEndpointSendMessageRaw().
|
inline |
send a data block and length
dest | destination to send the message to |
data | pointer to data location |
data_size | the length of the data |
time | the time to send the message |
References data, and helicsEndpointSendEventRaw().
|
inline |
send a string to a particular destination
dest | the target endpoint to send the data to |
data | the information to send |
References data, and helicsEndpointSendMessageRaw().
|
inline |
send a string to a particular destination at a particular time
dest | the target endpoint to send the data to |
data | the information to send |
time | the time the message should be delivered |
References data, and helicsEndpointSendEventRaw().
|
inline |
send a vector of data to a particular destination
dest | the target endpoint to send the data to |
data | the information to send |
References data, and helicsEndpointSendMessageRaw().
|
inline |
send a vector of data to a particular destination at a particular time
dest | the target endpoint to send the data to |
data | the information to send |
time | the time the message should be delivered |
References data, and helicsEndpointSendEventRaw().
|
inline |
send a vector of data to the target destination
data | the information to send |
References data, and helicsEndpointSendMessageRaw().
|
inline |
send a vector of data to the target destination at a particular time
data | the information to send |
time | the time the message should be delivered |
References data, and helicsEndpointSendEventRaw().
|
inline |
send a message object
References helicsEndpointSendMessageObjectZeroCopy(), and helicscpp::Message::release().
|
inline |
set the default destination for an endpoint
References helicsEndpointSetDefaultDestination().
|
inline |
set the interface information field of the filter
References helicsEndpointSetInfo().