com::softwareag::connectivity Namespace Reference

Contains classes relating to the connectivity system. More...

Classes
class	AbstractCodec
	Abstract class for Codecs. More...
class	AbstractSimpleCodec
	Helper derivative of AbstractCodec implementing message-by-message transformation. More...
class	AbstractSimpleTransport
	Helper derivative of AbstractTransport implementing message-by-message delivery. More...
class	AbstractTransport
	Abstract class for Transports. More...
class	buffer_t
	A class that holds an untyped byte buffer. More...
class	const_visitor
	Helper class for writing visitors to apply to data_t. More...
class	custom_t
	A wrapper type for holding arbitrary objects inside a data_t. More...
class	data_t
	A variant type which can be one of the following: More...
class	HostSide
	An interface to the next component (plugin or host) towards the host. More...
class	list_t
	A list class which implements many of the functions on std::vector. More...
class	Logger
	Class for writing to the system logger. More...
class	map_t
	A map class which implements many of the functions on std::map. More...
class	MapHelper
	Helper class for extracting values from a string->data_t map_t in a type-safe way with error checking and support for defalut values. More...
class	Message
	A container for an payload and associated metadata. More...
class	metadata_t
	A map class which implements many of the functions on std::map. More...
class	Plugin
	Base of the inheritence tree for Connectivity plugins. More...
class	RemoteHostSide
	Wrap the next plugin in order as a HostSide object. More...
class	RemoteTransportSide
	Wrap the next plugin in order as a TransportSide object. More...
class	TransportSide
	An interface to the next component (plugin or host) towards the transport. More...
class	visitor
	Helper class for writing visitors to apply to data_t. More...

Functions
template<typename V >
V::result_type	apply_visitor (const V &v, data_t &t)
	Apply a visitor (using the boost::static_visitor pattern) to the given data_t. More...
template<typename V >
V::result_type	apply_visitor (const V &v, const data_t &t)
	Apply a visitor (using the boost::static_visitor pattern) to the given data_t. More...
template<typename T >
get_details::GetVisitor< const T >::result_type	get (const data_t &t)
	Get the contents of the variant, given the type. More...
template<typename T >
get_details::GetVisitor< T > ::result_type	get (data_t &t)
	Get the contents of the variant, given the type. More...
template<typename T >
get_details::GetVisitor < custom_t< T > >::result_type	get_custom (data_t &t)
	Get the contents of the variant as a typed custom_t. More...
template<typename T >
get_details::GetVisitor< const custom_t< T > >::result_type	get_custom (const data_t &t)
	Get the contents of the variant as a typed custom_t. More...
template<typename T >
T	convert_to (const data_t &d)
	Get a T from a data_t, parsing it from a string if neccessary/possible. More...

Detailed Description

Contains classes relating to the connectivity system.

Function Documentation

template<typename V >

V::result_type com::softwareag::connectivity::apply_visitor ( const V &  v, data_t &  t  )

inline

Apply a visitor (using the boost::static_visitor pattern) to the given data_t.

This is the main mechanism for accessing the data if you don't know which type. Your visitor should implement operator() for each of the possible contained types and the appropriate method will be called, depending on which type is in the variant. If the variant is empty then the 0-args operator() will be used.

The return value of the operators will be returned from this method. Visitors must define a result_type member (or make use of boost::static_visitor, which provides this). Alternatively connectivity::visitor may be used when you only need to implement specific type visitation which also provides result_type.

template<typename V >

V::result_type com::softwareag::connectivity::apply_visitor ( const V &  v, const data_t &  t  )

inline

Apply a visitor (using the boost::static_visitor pattern) to the given data_t.

This is the main mechanism for accessing the data if you don't know which type. Your visitor should implement operator() for each of the possible contained types and the appropriate method will be called, depending on which type is in the variant. If the variant is empty then the 0-args operator() will be used.

The return value of the operators will be returned from this method. Visitors must define a result_type member (or make use of boost::static_visitor, which provides this). Alternatively connectivity::visitor may be used when you only need to implement specific type visitation which also provides result_type.

template<typename T >

T com::softwareag::connectivity::convert_to ( const data_t &  d )

inline

Get a T from a data_t, parsing it from a string if neccessary/possible.

If it cannot be converted, or is not either T or a string, then will throw std::runtime_error.

Only the following types can be used with convert_to:

• int64_t
• double
• bool
• std::string

template<typename T >

get_details::GetVisitor<const T>::result_type com::softwareag::connectivity::get ( const data_t &  t )

inline

Get the contents of the variant, given the type.

This is the primary way of accessing the contents of the variant if you know which type it will be.

get is templated over one of the types the variant can contain. If the variant contains a value of that type then it will be returned. If not, get will throw std::runtime_error.

template<typename T >

get_details::GetVisitor<T>::result_type com::softwareag::connectivity::get ( data_t &  t )

inline

Get the contents of the variant, given the type.

This is the primary way of accessing the contents of the variant if you know which type it will be.

get is templated over one of the types the variant can contain. If the variant contains a value of that type then it will be returned. If not, get will throw std::runtime_error.

template<typename T >

get_details::GetVisitor<custom_t<T> >::result_type com::softwareag::connectivity::get_custom ( data_t &  t )

inline

Get the contents of the variant as a typed custom_t.

This is a shorthand for using get:

get_custom<T>(data) == get<custom_t<T> >(data)

template<typename T >

get_details::GetVisitor<const custom_t<T> >::result_type com::softwareag::connectivity::get_custom ( const data_t &  t )

inline

Get the contents of the variant as a typed custom_t.

This is a shorthand for using get:

get_custom<T>(data) == get<custom_t<T> >(data)