Convenience alias for Client with message security enabled. More...

#include <client.h>

Inheritance diagram for vlink::SecurityClient< ReqT, RespT >:

Collaboration diagram for vlink::SecurityClient< ReqT, RespT >:

Additional Inherited Members
Public Types inherited from vlink::Client< ReqT, Traits::EmptyType, SecurityType::kWithSecurity >
using	UniquePtr
	Unique-pointer alias.
using	SharedPtr
	Shared-pointer alias.
using	ConnectCallback
	Callback type fired when server connection state changes.
using	RespCallback
	Callback type for async response delivery.
Public Types inherited from vlink::Node< ClientImpl, SecT >
using	StatusCallback
	Callback type for node status-change notifications.
Public Member Functions inherited from vlink::Client< ReqT, Traits::EmptyType, SecurityType::kWithSecurity >
	Client (const ConfT &conf, InitType type=InitType::kWithInit)
	Constructs a client from a typed transport configuration object.
	~Client () override
void	detect_connected (ConnectCallback &&callback)
	Registers a callback invoked when the server connection state changes.
bool	wait_for_connected (std::chrono::milliseconds timeout=Timeout::kDefaultInterval)
	Blocks until a server is available or the timeout expires.
bool	is_connected () const
	Returns `true` if a server is currently available.
bool	invoke (const ReqT &req, Traits::EmptyType &resp, std::chrono::milliseconds timeout=Timeout::kDefaultInterval)
	Sends a request and blocks until the response is received.
std::future< Traits::EmptyType >	async_invoke (const ReqT &req)
	Sends a request and returns a `std::future` for the response.
bool	send (const ReqT &req)
	Sends a fire-and-forget request with no response.
Public Member Functions inherited from vlink::Node< ClientImpl, SecT >
virtual bool	init ()
	Initialises the node and its transport back-end.
virtual bool	deinit ()
	Shuts down the node and releases all transport resources.
virtual void	interrupt ()
	Unblocks any active blocking wait on this node.
bool	has_inited () const
	Returns `true` if `init()` has been successfully called.
bool	is_support_loan () const
	Returns `true` if the transport supports zero-copy loaned buffers.
Bytes	loan (int64_t size)
	Allocates a loaned buffer from the transport memory pool.
bool	return_loan (const Bytes &bytes)
	Returns a previously loaned buffer back to the transport pool.
virtual void	set_manual_unloan (bool manual_unloan)
	Enables or disables manual-unloan mode for zero-copy receives.
virtual bool	is_manual_unloan () const
	Returns `true` if manual-unloan mode is active.
bool	suspend ()
	Suspends message delivery on this node.
bool	resume ()
	Resumes message delivery after a `suspend()`.
bool	is_suspend () const
	Returns `true` if the node is currently suspended.
bool	attach (class MessageLoop *message_loop)
	Attaches the node to a `MessageLoop` for callback dispatching.
bool	detach ()
	Detaches the node from its current `MessageLoop`.
class MessageLoop *	get_message_loop () const
	Returns the `MessageLoop` this node is attached to.
const AbstractNode *	get_abstract_node () const
	Returns the abstract node handle for graph introspection.
Status::BasePtr	get_status (Status::Type type) const
	Returns the current status object for the specified status type.
void	register_status_handler (StatusCallback &&callback)
	Registers a handler called when the node's status changes.
void	set_property (const std::string &prop, const std::string &value)
	Sets a transport-specific key-value property on the node.
std::string	get_property (const std::string &prop) const
	Retrieves a transport-specific property value.
TransportType	get_transport_type () const
	Returns the `TransportType` of the transport this node is bound to.
const std::string &	get_url () const
	Returns the URL string used to construct this node.
void	set_security_key (const std::string &key)
	Sets the symmetric encryption key for message security.
void	set_record_path (const std::string &path)
	Sets the filesystem path for message bag recording.
void	set_security_callbacks (Security::Callback &&encrypt_callback, Security::Callback &&decrypt_callback)
	Installs custom encrypt and decrypt callbacks.
void	set_ser_type (const std::string &ser_type, SchemaType schema_type=SchemaType::kUnknown)
	Overrides the runtime wire metadata for this node.
const std::string &	get_ser_type () const
	Returns the current serialisation type string.
SchemaType	get_schema_type () const
	Returns the current coarse schema family.
void	set_discovery_enabled (bool enable)
	Enables or disables peer-discovery on this node.
bool	get_discovery_enabled () const
	Returns `true` if peer-discovery is currently enabled.
void	bind_proto_arena (void *proto_arena)
	Binds a Protobuf Arena for arena-allocated message objects.
double	get_cpu_usage () const
	Returns the cumulative CPU usage ratio for this node.
bool	get_safety_quit () const
	Returns `true` if safe-quit mode is currently active.
void	set_safety_quit (bool safety_quit)
	Enables or disables safe-quit mode.
void	set_ssl_options (const SslOptions &options)
	Configures transport-layer SSL/TLS encryption for this node.
Static Public Member Functions inherited from vlink::Client< ReqT, Traits::EmptyType, SecurityType::kWithSecurity >
static UniquePtr	create_unique (const std::string &url_str, InitType type=InitType::kWithInit)
	Creates a `Client` on the heap wrapped in a `unique_ptr`.
static SharedPtr	create_shared (const std::string &url_str, InitType type=InitType::kWithInit)
	Creates a `Client` on the heap wrapped in a `shared_ptr`.
Static Public Attributes inherited from vlink::Client< ReqT, Traits::EmptyType, SecurityType::kWithSecurity >
static constexpr ImplType	kImplType
	Node role identifier (`kClient`).
static constexpr bool	kHasResp
	`true` when `RespT` is not `EmptyType` (client expects a response).
static constexpr Serializer::Type	kReqType
	Serializer type for `ReqT`.
static constexpr Serializer::Type	kRespType
	Serializer type for `RespT`.
Protected Member Functions inherited from vlink::Node< ClientImpl, SecT >
	Node ()
virtual	~Node ()
void	enable_security ()
void	invoke_callback (const CallbackT &callback, ArgsT &&... args)
TypeT	get_default_value ()
Protected Attributes inherited from vlink::Node< ClientImpl, SecT >
std::atomic_bool	has_inited_
std::unique_ptr< ClientImpl >	impl_
std::optional< Security >	security_
std::optional< std::mutex >	quit_mtx_
void *	proto_arena_
bool	is_support_loan_
bool	is_manual_unloan_

Detailed Description

template<typename ReqT, typename RespT = Traits::EmptyType>
class vlink::SecurityClient< ReqT, RespT >

Convenience alias for Client with message security enabled.

Equivalent to Client<ReqT, RespT, SecurityType::kWithSecurity>. Each outgoing request is encrypted and each incoming response is decrypted using the configured security key or callbacks.

Template Parameters

ReqT	Request type.
RespT	Response type (defaults to `Traits::EmptyType`).

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

include/vlink/client.h

Additional Inherited Members

Detailed Description