roc::netio::NetworkLoop::Tasks::AddTcpClientPort Class Reference

Add TCP client port. More...

#include <network_loop.h>

Inheritance diagram for roc::netio::NetworkLoop::Tasks::AddTcpClientPort:

Collaboration diagram for roc::netio::NetworkLoop::Tasks::AddTcpClientPort:

Public Member Functions
	AddTcpClientPort (TcpClientConfig &config, IConnHandler &conn_handler)
	Set task parameters. More...
PortHandle	get_handle () const
	Get created port handle. More...
Public Member Functions inherited from roc::netio::NetworkTask
bool	success () const
	Check that the task finished and succeeded. More...
Public Member Functions inherited from roc::core::MpscQueueNode< Tag >
MpscQueueData *	mpsc_queue_data () const
	Get pointer to internal data. More...

Friends
class	NetworkLoop

Additional Inherited Members
Static Public Member Functions inherited from roc::core::MpscQueueNode< Tag >
static MpscQueueNode *	mpsc_queue_node (MpscQueueData *data)
	Get pointer to parent node from pointer to internal data. More...
Protected Types inherited from roc::netio::NetworkTask
enum	State {   StateInitialized , StatePending , StateClosingPort , StateFinishing ,   StateFinished }
	Task state. More...
Protected Attributes inherited from roc::netio::NetworkTask
void(NetworkLoop::*	func_ )(NetworkTask &)
	Task implementation method. More...
core::Atomic< int >	state_
	Task state, defines whether task is finished already. The task becomes immutable after setting state to Finished. More...
core::Atomic< int >	success_
	Task result, defines wether finished task succeeded or failed. Makes sense only after setting state_ to Finished. This atomic should be assigned before setting state_ to Finished. More...
core::SharedPtr< BasicPort >	port_
	On which port the task operates. More...
void *	port_handle_
	Port handle. More...
INetworkTaskCompleter *	completer_
	Completion handler. More...
core::Optional< core::Semaphore >	sem_
	Completion semaphore. More...

Detailed Description

Add TCP client port.

Definition at line 138 of file network_loop.h.

Constructor & Destructor Documentation

AddTcpClientPort()

roc::netio::NetworkLoop::Tasks::AddTcpClientPort::AddTcpClientPort	(	TcpClientConfig &	config,
		IConnHandler &	conn_handler
	)

Set task parameters.

Remarks

• Updates config with the actual bind address.
• Notofies conn_handler when connection state changes.

Member Function Documentation

get_handle()

PortHandle roc::netio::NetworkLoop::Tasks::AddTcpClientPort::get_handle

(

)

const

Get created port handle.

Precondition

Should be called only after success() is true.

---

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

• roc_netio/target_libuv/roc_netio/network_loop.h