![]() |
helics
2.8.1
|
#include <Endpoints.hpp>
Public Member Functions | |
Endpoint ()=default | |
Endpoint (MessageFederate *mfed, const std::string &name, interface_handle id, void *data) | |
Endpoint (MessageFederate *mFed, const std::string &name, const std::string &type=std::string()) | |
template<class FedPtr > | |
Endpoint (FedPtr &mFed, const std::string &name, const std::string &type=std::string()) | |
Endpoint (interface_visibility locality, MessageFederate *mFed, const std::string &name, const std::string &type=std::string()) | |
template<class FedPtr > | |
Endpoint (interface_visibility locality, FedPtr &mFed, const std::string &name, const std::string &type=std::string()) | |
bool | isValid () const |
bool | operator== (const Endpoint &ept) const |
bool | operator!= (const Endpoint &ept) const |
bool | operator< (const Endpoint &ept) const |
void | send (const std::string &dest, const char *data, size_t data_size) const |
void | subscribe (const std::string &key) |
void | send (const std::string &dest, const char *data, size_t data_size, Time sendTime) const |
void | send (const char *data, size_t data_size, Time sendTime) const |
void | send (const std::string &dest, const data_view &data) const |
void | send (const std::string &dest, const data_view &data, Time sendTime) const |
void | send (const char *data, size_t data_size) const |
void | send (const data_view &data) const |
void | send (const data_view &data, Time sendTime) const |
void | send (std::unique_ptr< Message > mess) const |
void | send (const Message &mess) const |
auto | getMessage () const |
bool | hasMessage () const |
auto | pendingMessages () const |
void | setCallback (const std::function< void(const Endpoint &, Time)> &callback) |
void | addSourceFilter (const std::string &filterName) |
void | addDestinationFilter (const std::string &filterName) |
void | setDefaultDestination (std::string target) |
const std::string & | getDefaultDestination () const |
const std::string & | getName () const |
const std::string & | getKey () const |
const std::string & | getType () const |
interface_handle | getHandle () const |
** get the number of filters applied to the endpoint*/ More... | |
operator interface_handle () const | |
const std::string & | getInfo () const |
void | setInfo (const std::string &info) |
void | setOption (int32_t option, int32_t value=1) |
int32_t | getOption (int32_t option) const |
void | close () |
Friends | |
class | MessageFederateManager |
class to manage an endpoint
|
default |
default constructor
helics::Endpoint::Endpoint | ( | interface_visibility | locality, |
MessageFederate * | mFed, | ||
const std::string & | name, | ||
const std::string & | type = std::string() |
||
) |
constructor to build an endpoint object
locality | visibility of the endpoint either global or local |
mFed | the MessageFederate to use |
name | the name of the endpoint |
type | a named type associated with the endpoint |
|
inline |
constructor to build an endpoint object
locality | visibility of the endpoint either global or local |
mFed | the MessageFederate to use |
name | the name of the endpoint |
type | a named type associated with the endpoint |
|
inline |
add a named filter to an endpoint for all message going to the endpoint
References fed.
|
inline |
add a named filter to an endpoint for all message coming from the endpoint
References fed.
|
inline |
close the endpoint from receiving more messages
References fed.
|
inline |
get the target destination for the endpoint
|
inline |
** get the number of filters applied to the endpoint*/
get the actual endpoint id for the fed
|
inline |
get the interface information field of the publication
References fed.
|
inline |
get the name of the endpoint
References fed.
|
inline |
get an available message if there is no message the returned object is empty
References fed.
|
inline |
get the name of the endpoint
Referenced by helics::MessageFederateManager::registerKnownCommunicationPath().
|
inline |
get the current value of a flag for the handle
References fed.
|
inline |
get the specified type of the endpoint
References fed.
|
inline |
check if there is a message available
References fed.
|
inline |
check if the Endpoint links to a valid operation
|
inline |
implicit conversion operator for extracting the handle
|
inline |
check if there is a message available
References fed.
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
send a pointer to a message object
References fed.
|
inline |
register a callback for an update notification
the callback is called in the just before the time request function returns
callback | a function with signature void(endpoint_id_t, Time) time is the time the value was updated This callback is a notification callback and doesn't return the value |
References fed.
|
inline |
set a target destination for unspecified messages
|
inline |
set the interface information field of the publication
References fed.
|
inline |
subscribe the endpoint to a particular publication
References fed.