eq::net::MCIPConnection Class Reference

A facade for hiding different IP-based reliable multicast implementations. More...

#include <mcipConnection.h>

Inheritance diagram for eq::net::MCIPConnection:

[legend]

Collaboration diagram for eq::net::MCIPConnection:

[legend]

List of all members.

Public Member Functions
virtual bool	connect ()
	Connect to the remote peer.
virtual bool	listen ()
	Put the connection into the listening state.
virtual void	close ()
	Close a connected or listening connection.
virtual void	acceptNB ()
	Start an accept operation.
virtual ConnectionPtr	acceptSync ()
	Complete an accept operation.
virtual void	readNB (void *buffer, const uint64_t bytes)
	Start a read operation on the connection.
virtual int64_t	readSync (void *buffer, const uint64_t bytes)
	Finish reading data from the connection.
virtual Notifier	getNotifier () const
Protected Member Functions
virtual int64_t	write (const void *buffer, const uint64_t bytes)
	Write data to the connection.
virtual void	notifyStateChanged (Connection *connection)

---

Detailed Description

A facade for hiding different IP-based reliable multicast implementations.

Definition at line 32 of file mcipConnection.h.

---

Member Function Documentation

bool eq::net::MCIPConnection::connect

(

)

[virtual]

Connect to the remote peer.

The ConnectionDescription of this connection is used to identify the peer's parameters.

Returns:

true if the connection was successfully connected, false if not.

Reimplemented from eq::net::Connection.

Definition at line 41 of file mcipConnection.cpp.

References eq::net::Connection::_description, eq::net::CONNECTIONTYPE_MCIP, eq::net::CONNECTIONTYPE_PGM, and eq::net::CONNECTIONTYPE_RSP.

bool eq::net::MCIPConnection::listen

(

)

[virtual]

Put the connection into the listening state.

The ConnectionDescription of this connection is used to identify the listening parameters.

Returns:

true if the connection is listening for new incoming connections, false if not.

Reimplemented from eq::net::Connection.

Definition at line 73 of file mcipConnection.cpp.

References eq::net::Connection::_description, eq::net::CONNECTIONTYPE_MCIP, eq::net::CONNECTIONTYPE_PGM, and eq::net::CONNECTIONTYPE_RSP.

void eq::net::MCIPConnection::acceptNB

(

)

[virtual]

Start an accept operation.

This method returns immediately. The Notifier will signal a new connection request, upon which acceptSync() should be used to finish the accept operation.

See also:

acceptSync()

Reimplemented from eq::net::Connection.

Definition at line 113 of file mcipConnection.cpp.

References eq::base::RefPtr< T >::isValid().

Here is the call graph for this function:

ConnectionPtr eq::net::MCIPConnection::acceptSync

(

)

[virtual]

Complete an accept operation.

Returns:

the new connection, 0 on error.

Reimplemented from eq::net::Connection.

Definition at line 120 of file mcipConnection.cpp.

References eq::base::RefPtr< T >::isValid().

Here is the call graph for this function:

void eq::net::MCIPConnection::readNB	(	void *	buffer,
		const uint64_t	bytes
	)			[virtual]

Start a read operation on the connection.

This method is the low-level counterpart to recvNB().

This function returns immediately. The operation's Notifier will signal data availability, upon which readSync() should be used to finish the operation.

Parameters:

	buffer	the buffer receiving the data.
	bytes	the number of bytes to read.

See also:

readSync()

Implements eq::net::Connection.

Definition at line 129 of file mcipConnection.cpp.

References eq::base::RefPtr< T >::isValid().

Here is the call graph for this function:

int64_t eq::net::MCIPConnection::readSync	(	void *	buffer,
		const uint64_t	bytes
	)			[virtual]

Finish reading data from the connection.

This method is the low-level counterpart to recvSync(). It may return with a partial read.

Parameters:

	buffer	the buffer receiving the data.
	bytes	the number of bytes to read.

Returns:

the number of bytes read, or -1 upon error.

Implements eq::net::Connection.

Definition at line 136 of file mcipConnection.cpp.

References eq::base::RefPtr< T >::isValid().

Here is the call graph for this function:

Connection::Notifier eq::net::MCIPConnection::getNotifier

(

)

const [virtual]

Returns:

the notifier signaling events on the connection.

Reimplemented from eq::net::Connection.

Definition at line 145 of file mcipConnection.cpp.

References eq::base::RefPtr< T >::isValid().

Here is the call graph for this function:

int64_t eq::net::MCIPConnection::write	(	const void *	buffer,
		const uint64_t	bytes
	)			[protected, virtual]

Write data to the connection.

Parameters:

	buffer	the buffer containing the message.
	bytes	the number of bytes to write.

Returns:

the number of bytes written, or -1 upon error.

Implements eq::net::Connection.

Definition at line 154 of file mcipConnection.cpp.

References eq::base::RefPtr< T >::isValid().

Here is the call graph for this function:

---

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

• mcipConnection.h
• mcipConnection.cpp