rofl::csocket_env Interface Reference

An abstract interface defining the consumer side of a csocket. More...

#include <csocket.h>

Public Member Functions
virtual	~csocket_env ()
	Destructor.
virtual void	handle_listen (rofl::csocket &socket, int newsd)=0
	Called once a listening socket has accepted a connection request from a remote peer entity. More...
virtual void	handle_accepted (rofl::csocket &socket)=0
	Called once this csocket entity has succeeded its accept() method. More...
virtual void	handle_accept_refused (rofl::csocket &socket)=0
	Called once accepting a request from a remote entity failed. More...
virtual void	handle_connected (rofl::csocket &socket)=0
	Called once a connection request has succeeded its connect() method. More...
virtual void	handle_connect_refused (rofl::csocket &socket)=0
	Called once a connection request to a remote entity failed. More...
virtual void	handle_connect_failed (rofl::csocket &socket)=0
	Called once a connection request to a remote entity failed. More...
virtual void	handle_read (rofl::csocket &socket)=0
	Called once new data is available for reading from the socket. More...
virtual void	handle_write (rofl::csocket &socket)=0
	Called once the socket accept additional data for sending. More...
virtual void	handle_closed (rofl::csocket &socket)=0
	Called once the socket has been shutdown and closed. More...

Friends
class	csocket

Detailed Description

An abstract interface defining the consumer side of a csocket.

This class defines an abstract interface for interacting with instances of type csocket. It defines five methods for reception of notifications emitted by specific socket events:

• accepted
• connected
• connect_refised
• read
• closed All methods are pure abstract and must be implemented by a class deriving from csocket_env.

See Also

csocket

Inheritance diagram for rofl::csocket_env:

Member Function Documentation

virtual void rofl::csocket_env::handle_accept_refused ( rofl::csocket &  socket )

pure virtual

Called once accepting a request from a remote entity failed.

Parameters

socket

pointer to csocket instance emitting the notification

Implemented in rofl::csocket_openssl.

virtual void rofl::csocket_env::handle_accepted ( rofl::csocket &  socket )

pure virtual

Called once this csocket entity has succeeded its accept() method.

Parameters

socket	pointer to csocket instance emitting the motification
newsd	socket descriptor of new created Unix socket
ra	address of peer entity

Implemented in rofl::csocket_openssl.

virtual void rofl::csocket_env::handle_closed ( rofl::csocket &  socket )

pure virtual

Called once the socket has been shutdown and closed.

Parameters

socket	pointer to csocket instance emitting the notification
sd	socket descriptor used by the connection

Implemented in rofl::csocket_openssl.

virtual void rofl::csocket_env::handle_connect_failed ( rofl::csocket &  socket )

pure virtual

Called once a connection request to a remote entity failed.

Parameters

socket	pointer to csocket instance emitting the notification
sd	socket descriptor used for connection

Implemented in rofl::csocket_openssl.

virtual void rofl::csocket_env::handle_connect_refused ( rofl::csocket &  socket )

pure virtual

Called once a connection request to a remote entity failed.

Parameters

socket	pointer to csocket instance emitting the notification
sd	socket descriptor used for connection

Implemented in rofl::csocket_openssl.

virtual void rofl::csocket_env::handle_connected ( rofl::csocket &  socket )

pure virtual

Called once a connection request has succeeded its connect() method.

Parameters

socket

pointer to csocket instance emitting the notification

Implemented in rofl::csocket_openssl.

virtual void rofl::csocket_env::handle_listen ( rofl::csocket &  socket, int  newsd  )

pure virtual

Called once a listening socket has accepted a connection request from a remote peer entity.

Parameters

socket	pointer to csocket instance emitting the motification
newsd	socket descriptor of new created Unix socket
ra	address of peer entity

Implemented in rofl::csocket_openssl.

virtual void rofl::csocket_env::handle_read ( rofl::csocket &  socket )

pure virtual

Called once new data is available for reading from the socket.

Parameters

socket	pointer to csocket instance emitting the notification
sd	socket descriptor used by the connection

Implemented in rofl::csocket_openssl.

virtual void rofl::csocket_env::handle_write ( rofl::csocket &  socket )

pure virtual

Called once the socket accept additional data for sending.

Parameters

socket	pointer to csocket instance emitting the notification
sd	socket descriptor used by the connection

Implemented in rofl::csocket_openssl.

---

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

• /home/andreas/git/rofl-core/src/rofl/common/csocket.h