msg_connection Class Reference

base class for all types of connections More...

#include <msg_conn.h>

Inheritance diagram for msg_connection:

List of all members.

Public Member Functions
	msg_connection (msg_communicator *communicator, const conf_listener &linfo, const conf_connection &info)
	constructor for receiver
	msg_connection (msg_communicator *communicator, const conf_connection &info)
	constructor for initiator
virtual	~msg_connection ()
	destructor
virtual void	push_msg (msg_cpp *msg)
	before pushing message into connection queue assigns the session id of this connection
const room_byte_t *	get_crypt_key ()
	returns private symmetric crypt key
void	set_last_activity ()
	refreshes the last activity date
bool	is_last_activity_timeout ()
	checks if it's time for ping
virtual void	ping_notify ()
	inserts ping message into output queue
const conf_connection &	get_info ()
	returns the connection info
const rsa *	get_rsa () const
	returns RSA object pointer (optional)
bool	is_connected () const
msg_cpp *	prepare_handshake_msg ()
	prepares handshake message as a initiator
msg_cpp *	prepare_handshake_reply (msg_cpp *msg)
	prepares handshake reply as a receiver
void	validate_handshake_reply (msg_cpp *msg)
	validates handshake reply as a initiator
void	process_incoming_message (msg_cpp *msg)
Protected Types
enum	msg_conn_state { CONN_STATE_CLOSE, CONN_STATE_HANDSHAKE_INITIATOR, CONN_STATE_HANDSHAKE_RECEIVER, CONN_STATE_CONNECTED }
Protected Member Functions
virtual void	wakeup ()
	overrides the base functionality
Protected Attributes
conf_connection	_info
	connection info
conf_listener	_linfo
	listener acceptence settings
msg_conn_state	_state
	connection state
rsa	_rsa
	crypto object
Private Attributes
date	_last_activity
	keep last activity date

---

Detailed Description

base class for all types of connections

Definition at line 44 of file msg_conn.h.

---

Member Enumeration Documentation

enum msg_connection::msg_conn_state [protected]

Enumerator:

CONN_STATE_CLOSE	close state
CONN_STATE_HANDSHAKE_INITIATOR	connection established, handshake in progress
CONN_STATE_HANDSHAKE_RECEIVER	connection accepted, handshake in progress
CONN_STATE_CONNECTED	connection is ready for sending/receiving messages

Definition at line 48 of file msg_conn.h.

---

Constructor & Destructor Documentation

msg_connection::msg_connection	(	msg_communicator *	communicator,
		const conf_listener &	linfo,
		const conf_connection &	info
	)

constructor for receiver

Parameters:

communicator	pointer to communicator
linfo	listener acceptence settings
info	connection info

Definition at line 40 of file msg_conn.cpp.

References msg_base::_communicator, conf_connection::_crypt_external, conf_connection::_crypt_private, _info, conf_connection::_session, conf_connection::_support_crypt, and msg_communicator::get_msg_key().

msg_connection::msg_connection	(	msg_communicator *	communicator,
		const conf_connection &	info
	)

constructor for initiator

Parameters:

communicator	pointer to communicator
info	connection info

Definition at line 53 of file msg_conn.cpp.

References msg_base::_communicator, conf_connection::_crypt_external, conf_connection::_crypt_private, _info, conf_connection::_session, conf_connection::_support_crypt, and msg_communicator::get_msg_key().

msg_connection::~msg_connection

(

)

[virtual]

destructor

Definition at line 67 of file msg_conn.cpp.

References msg_base::_communicator, msg_communicator::destroy_msg(), and msg_queue< 3 >::pop().

---

Member Function Documentation

void msg_connection::push_msg

(

msg_cpp *

msg

)

[virtual]

before pushing message into connection queue assigns the session id of this connection

Parameters:

msg	message pointer

Reimplemented in msg_user_connection.

Definition at line 109 of file msg_conn.cpp.

References _info, conf_connection::_session, msg_cpp::_sessionid, and msg_queue< 3 >::push().

Referenced by ping_notify(), msg_user_connection::push_msg(), and msg_communicator::v_do_job().

const room_byte_t* msg_connection::get_crypt_key

(

)

[inline]

returns private symmetric crypt key

Definition at line 76 of file msg_conn.h.

References conf_connection::_crypt_private, _info, conf_connection::_support_crypt, and room_array< T >::size().

Referenced by msg_rpc_connection::send_msg(), ServerPostBlock(), msg_sock_connection::v_do_job(), and msg_sock_connection::v_on_receive().

void msg_connection::set_last_activity

(

)

[inline]

refreshes the last activity date

Definition at line 83 of file msg_conn.h.

References _last_activity, and msg_base::_mtx_res.

Referenced by msg_user_connection::ping_notify(), ping_notify(), process_incoming_message(), msg_sock_connection::v_do_job(), and msg_rpc_connection::v_do_job().

bool msg_connection::is_last_activity_timeout

(

)

[inline]

checks if it's time for ping

Definition at line 91 of file msg_conn.h.

References _info, _last_activity, msg_base::_mtx_res, conf_connection::_ping, and date::is_time_over().

void msg_connection::ping_notify

(

)

[virtual]

inserts ping message into output queue

Reimplemented in msg_user_connection.

Definition at line 79 of file msg_conn.cpp.

References conf_connection::_address, msg_base::_communicator, _info, msg_communicator::construct_ping(), smart_pointer< C >::detach(), push_msg(), and set_last_activity().

const conf_connection& msg_connection::get_info

(

)

[inline]

returns the connection info

Definition at line 103 of file msg_conn.h.

References _info.

Referenced by msg_communicator::add_connection(), msg_communicator::change_connection_address(), ServerPostBlock(), and msg_communicator::shutdown_connection().

const rsa* msg_connection::get_rsa

(

)

const [inline]

returns RSA object pointer (optional)

Definition at line 109 of file msg_conn.h.

References _info, _rsa, and conf_connection::_support_crypt.

Referenced by prepare_handshake_msg(), process_incoming_message(), ServerPostBlock(), and validate_handshake_reply().

bool msg_connection::is_connected

(

)

const [inline]

Definition at line 115 of file msg_conn.h.

References _state, and CONN_STATE_CONNECTED.

msg_cpp * msg_connection::prepare_handshake_msg

(

)

prepares handshake message as a initiator

Definition at line 123 of file msg_conn.cpp.

References conf_connection::_address, msg_base::_communicator, _info, msg_cpp::_receiver, conf_connection::_session, msg_cpp::_sessionid, msg_communicator::construct_handshake(), and get_rsa().

Referenced by msg_rpc_connection::connect(), and msg_sock_connection::v_on_connect().

msg_cpp * msg_connection::prepare_handshake_reply

(

msg_cpp *

msg

)

prepares handshake reply as a receiver

Definition at line 135 of file msg_conn.cpp.

References conf_connection::_address, msg_base::_communicator, conf_connection::_crypt_private, _info, _linfo, msg_cpp::_sender, conf_connection::_session, msg_cpp::_sessionid, _state, conf_connection::_support_crypt, msg_listener::accept_address(), CONN_STATE_CONNECTED, msg_communicator::reply_handshake(), and msg_t::timeout.

Referenced by ServerConnect().

void msg_connection::validate_handshake_reply

(

msg_cpp *

msg

)

validates handshake reply as a initiator

Definition at line 156 of file msg_conn.cpp.

References conf_connection::_address, msg_base::_communicator, conf_connection::_crypt_private, _info, msg_cpp::_sender, conf_connection::_session, _state, msg_communicator::check_handshake(), CONN_STATE_CONNECTED, and get_rsa().

Referenced by msg_rpc_connection::connect().

void msg_connection::process_incoming_message

(

msg_cpp *

msg

)

Parameters:

msg	pointer to message

Definition at line 165 of file msg_conn.cpp.

References conf_connection::_address, msg_base::_communicator, conf_connection::_crypt_private, _info, _linfo, msg_cpp::_sender, conf_connection::_session, msg_cpp::_sessionid, _state, conf_connection::_support_crypt, exception::_throw(), msg_cpp::_type, msg_listener::accept_address(), msg_communicator::change_connection_address(), msg_communicator::check_handshake(), msg_communicator::comm_msg(), CONN_STATE_CONNECTED, CONN_STATE_HANDSHAKE_INITIATOR, CONN_STATE_HANDSHAKE_RECEIVER, msg_communicator::destroy_msg(), smart_pointer< C >::detach(), get_rsa(), handshake_type, msg_id_ping, MSG_RESULT_INVALID_MSGFORMAT, MSG_RESULT_INVALID_SESSION, msg_t::msgid, msgMsgTable, msg_queue< 3 >::push(), msg_communicator::reply_handshake(), set_last_activity(), system_type, msg_t::timeout, user_type_post, user_type_reply, user_type_reply_async, user_type_send, user_type_send_async, and wakeup().

Referenced by ServerPostBlock(), and msg_sock_connection::v_on_receive().

void msg_connection::wakeup

(

)

[protected, virtual]

overrides the base functionality

Implements msg_queue< 3 >.

Reimplemented in msg_user_connection.

Definition at line 117 of file msg_conn.cpp.

References msg_base::_communicator, threadpool::borrow_thread(), msg_communicator::get_thread_manager(), queue_thread_ident, and stay_on_alert_time.

Referenced by process_incoming_message(), and msg_sock_connection::v_on_send().

---

Member Data Documentation

conf_connection msg_connection::_info [protected]

connection info

Definition at line 143 of file msg_conn.h.

Referenced by get_crypt_key(), get_info(), get_rsa(), is_last_activity_timeout(), msg_connection(), ping_notify(), msg_user_connection::post(), prepare_handshake_msg(), prepare_handshake_reply(), process_incoming_message(), push_msg(), msg_user_connection::send(), msg_user_connection::send_async(), msg_user_connection::v_do_job(), msg_sock_connection::v_do_job(), and validate_handshake_reply().

conf_listener msg_connection::_linfo [protected]

listener acceptence settings

Definition at line 144 of file msg_conn.h.

Referenced by prepare_handshake_reply(), and process_incoming_message().

msg_conn_state msg_connection::_state [protected]

connection state

Definition at line 145 of file msg_conn.h.

Referenced by msg_user_connection::connect(), is_connected(), prepare_handshake_reply(), process_incoming_message(), msg_sock_connection::v_has_job(), and validate_handshake_reply().

rsa msg_connection::_rsa [protected]

crypto object

Definition at line 146 of file msg_conn.h.

Referenced by get_rsa().

date msg_connection::_last_activity [private]

keep last activity date

Definition at line 148 of file msg_conn.h.

Referenced by is_last_activity_timeout(), and set_last_activity().

---

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

• msg_conn.h
• msg_conn.cpp