---

ost::SocketPort Class Reference

The socket port is an internal class which is attached to and then serviced by a specific SocketService "object". base class for realtime and thread pool serviced protocols. More...

#include <socket.h>

Inheritance diagram for ost::SocketPort:

List of all members.

Public Methods
void	setTimer (timeout_t timeout=0)
	Derived setTimer to notify the service thread pool of change in expected timeout.
void	incTimer (timeout_t timeout)
	Derived incTimer to notify the service thread pool of a change in expected timeout.
Protected Methods
	SocketPort (SocketService *svc, TCPSocket &tcp)
	Construct an accepted TCP socket connection from a specific bound TCP server.
	SocketPort (SocketService *svc, const InetAddress &ia, tpport_t port)
	Construct a bound UDP socket for use in deriving realtime UDP streaming protocols handled by thread pool objects.
	SocketPort (SocketService *svc, const InetHostAddress &ih, tpport_t port)
	A non-blocking constructor for outbound tcp connections.
void	attach (SocketService *svc)
	Attach yourself to the service pool thread object.
virtual	~SocketPort ()
	Disconnect the socket from the service thread pool and the remote connection.
void	setDetectPending (bool)
	Used to indicate if the service thread should monitor pending data for us.
bool	getDetectPending (void) const
	Get the current state of the DetectPending flag.
void	setDetectOutput (bool)
	Used to indicate if output ready monitoring should be performed by the service thread.
bool	getDetectOutput (void) const
	Get the current state of the DetectOutput flag.
virtual void	expired (void)
	Called by the service thread pool when the objects timer has expired.
virtual void	pending (void)
	Called by the service thread pool when input data is pending for this socket.
virtual void	output (void)
	Called by the service thread pool when output data is pending for this socket.
virtual void	disconnect (void)
	Called by the service thread pool when a disconnect has occured.
Error	connect (const InetAddress &ia, tpport_t port)
	Connect a Socket Port to a known peer host.
int	send (const void *buf, int len)
	Transmit "send" data to a connected peer host.
int	receive (void *buf, size_t len)
	Receive a message from any host.
int	peek (void *buf, size_t len)
	Examine the content of the next packet.
Friends
class	SocketService

---

Detailed Description

The socket port is an internal class which is attached to and then serviced by a specific SocketService "object". base class for realtime and thread pool serviced protocols.

Derived versions of this class offer specific functionality for specific protocols. Both Common C++ supporting frameworks and application objects may be derived from related protocol specific base classes.

A special set of classes, "SocketPort" and "SocketService", exist for building realtime streaming media servers on top of UDP and TCP protocols. The "SocketPort" is used to hold a connected or associated TCP or UDP socket which is being "streamed" and which offers callback methods that are invoked from a "SocketService" thread. SocketService's can be pooled into logical thread pools that can service a group of SocketPorts. A millisecond accurate "timer" is associated with each SocketPort and can be used to time synchronize SocketPort I/O operations.

Author:

David Sugar <dyfet@ostel.com>

---

Constructor & Destructor Documentation

ost::SocketPort::SocketPort (  SocketService *    svc, TCPSocket &    tcp )  [protected]

Construct an accepted TCP socket connection from a specific bound TCP server. This is meant to derive advanced application specific TCP servers that can be thread pooled. Parameters: svc  pool thread object. tcp  socket object to accept.

ost::SocketPort::SocketPort (  SocketService *    svc, const InetAddress &    ia, tpport_t    port )  [protected]

Construct a bound UDP socket for use in deriving realtime UDP streaming protocols handled by thread pool objects. Parameters: svc  pool thread object. ia  address of interface to bind. port  number to bind to.

ost::SocketPort::SocketPort (  SocketService *    svc, const InetHostAddress &    ih, tpport_t    port )  [protected]

A non-blocking constructor for outbound tcp connections. To detect when the connection is established, overload SocketPort::output(). SocketPort::output() get's called by the SocketService when the connection is ready, SocketPort::disconnect() when the connect failed. at the moment you should set the socket state to "CONNECTED" when SocketPort::output() get's called for the first time. Parameters: svc  pool thread object. ia  addess to connect to. port  number to connect to.

virtual ost::SocketPort::~SocketPort (    )  [protected, virtual]

Disconnect the socket from the service thread pool and the remote connection.

---

Member Function Documentation

void ost::SocketPort::attach (  SocketService *    svc )  [protected]

Attach yourself to the service pool thread object. The later version. Parameters: svc  pool thread object

Error ost::SocketPort::connect (  const InetAddress &    ia, tpport_t    port )  [protected]

Connect a Socket Port to a known peer host. This is normally used with the UDP constructor. This is also performed as a non-blocking operation under Posix systems to prevent delays in a callback handler. Returns: 0 if successful. Parameters: ia  address of remote host or subnet. port  number of remote peer(s).

virtual void ost::SocketPort::disconnect (  void    )  [inline, protected, virtual]

Called by the service thread pool when a disconnect has occured.

virtual void ost::SocketPort::expired (  void    )  [inline, protected, virtual]

Called by the service thread pool when the objects timer has expired. Used for timed events.

bool ost::SocketPort::getDetectOutput (  void    )  const [inline, protected]

Get the current state of the DetectOutput flag.

bool ost::SocketPort::getDetectPending (  void    )  const [inline, protected]

Get the current state of the DetectPending flag.

void ost::SocketPort::incTimer (  timeout_t    timeout )

Derived incTimer to notify the service thread pool of a change in expected timeout. This allows SocketService to reschedule all timers. Otherwise same as TimerPort. Parameters: timeout  in milliseconds. Reimplemented from ost::TimerPort.

virtual void ost::SocketPort::output (  void    )  [inline, protected, virtual]

Called by the service thread pool when output data is pending for this socket.

int ost::SocketPort::peek (  void *    buf, size_t    len )  [inline, protected]

Examine the content of the next packet. This can be used to build "smart" line buffering for derived TCP classes. Parameters: buf  pointer to packet buffer to examine. len  of packet buffer to examine. Returns: number of bytes actually available.

virtual void ost::SocketPort::pending (  void    )  [inline, protected, virtual]

Called by the service thread pool when input data is pending for this socket.

int ost::SocketPort::receive (  void *    buf, size_t    len )  [inline, protected]

Receive a message from any host. This is used in derived classes to build protocols. Parameters: buf  pointer to packet buffer to receive. len  of packet buffer to receive. Returns: number of bytes received.

int ost::SocketPort::send (  const void *    buf, int    len )  [inline, protected]

Transmit "send" data to a connected peer host. This is not public by default since an overriding protocol is likely to be used in a derived class. Returns: number of bytes sent. Parameters: buf  address of buffer to send. len  of bytes to send.

void ost::SocketPort::setDetectOutput (  bool    )  [protected]

Used to indicate if output ready monitoring should be performed by the service thread.

void ost::SocketPort::setDetectPending (  bool    )  [protected]

Used to indicate if the service thread should monitor pending data for us.

void ost::SocketPort::setTimer (  timeout_t    timeout = 0 )

Derived setTimer to notify the service thread pool of change in expected timeout. This allows SocketService to reschedule all timers. Otherwise same as TimerPort. Parameters: timeout  in milliseconds. Reimplemented from ost::TimerPort.

---

Friends And Related Function Documentation

friend class SocketService [friend]

---

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

• socket.h

---