StreamSocket Class Reference
[Basic sockets]

SOCK_STREAM Socket base class. More...

#include <StreamSocket.h>

Inheritance diagram for StreamSocket:

[legend]

Collaboration diagram for StreamSocket:

[legend]

List of all members.

Public Member Functions
	StreamSocket (ISocketHandler &)
	~StreamSocket ()
void	SetConnecting (bool=true)
	Socket should Check Connect on next write event from select().
bool	Connecting ()
	Check connecting flag.
bool	Ready ()
	Returns true when socket file descriptor is valid, socket connection is established, and socket is not about to be closed.
void	SetConnectTimeout (int x)
	Set timeout to use for connection attempt.
int	GetConnectTimeout ()
	Return number of seconds to wait for a connection.
void	SetFlushBeforeClose (bool=true)
	Set flush before close to make a tcp socket completely empty its output buffer before closing the connection.
bool	GetFlushBeforeClose ()
	Check flush before status.
void	SetConnectionRetry (int n)
	Define number of connection retries (tcp only).
int	GetConnectionRetry ()
	Get number of maximum connection retries (tcp only).
void	IncreaseConnectionRetries ()
	Increase number of actual connection retries (tcp only).
int	GetConnectionRetries ()
	Get number of actual connection retries (tcp only).
void	ResetConnectionRetries ()
	Reset actual connection retries (tcp only).
void	SetCallOnConnect (bool x=true)
	Instruct socket to call OnConnect callback next sockethandler cycle.
bool	CallOnConnect ()
	Check call on connect flag.
void	SetRetryClientConnect (bool x=true)
	Set flag to initiate a connection attempt after a connection timeout.
bool	RetryClientConnect ()
	Check if a connection attempt should be made.
virtual void	SetLineProtocol (bool=true)
	Called after OnRead if socket is in line protocol mode.
bool	LineProtocol ()
	Check line protocol mode.
void	SetShutdown (int)
	Set shutdown status.
int	GetShutdown ()
	Get shutdown status.
virtual int	Protocol ()=0
	Returns IPPROTO_TCP or IPPROTO_SCTP.
Protected Member Functions
	StreamSocket (const StreamSocket &)
Private Member Functions
StreamSocket &	operator= (const StreamSocket &)
Private Attributes
bool	m_bConnecting
	Flag indicating connection in progress.
int	m_connect_timeout
	Connection timeout (seconds).
bool	m_flush_before_close
	Send all data before closing (default true).
int	m_connection_retry
	Maximum connection retries (tcp).
int	m_retries
	Actual number of connection retries (tcp).
bool	m_call_on_connect
	OnConnect will be called next ISocketHandler cycle if true.
bool	m_b_retry_connect
	Try another connection attempt next ISocketHandler cycle.
bool	m_line_protocol
	Line protocol mode flag.
int	m_shutdown
	Shutdown status.

---

Detailed Description

SOCK_STREAM Socket base class.

Definition at line 44 of file StreamSocket.h.

---

Constructor & Destructor Documentation

StreamSocket::StreamSocket

(

ISocketHandler &

h

)

Definition at line 40 of file StreamSocket.cpp.

                                            : Socket(h)
,m_bConnecting(false)
,m_connect_timeout(5)
,m_flush_before_close(true)
,m_connection_retry(0)
,m_retries(0)
,m_call_on_connect(false)
,m_b_retry_connect(false)
,m_line_protocol(false)
,m_shutdown(0)
{
}

StreamSocket::~StreamSocket

(

)

Definition at line 54 of file StreamSocket.cpp.

{
}

StreamSocket::StreamSocket

(

const StreamSocket &

)

[inline, protected]

Definition at line 134 of file StreamSocket.h.

{} // copy constructor

---

Member Function Documentation

void StreamSocket::SetConnecting

(

bool

x = true

)

Socket should Check Connect on next write event from select().

Definition at line 59 of file StreamSocket.cpp.

References GetConnectTimeout(), m_bConnecting, and Socket::SetTimeout().

Referenced by SctpSocket::AddConnection(), TcpSocket::OnConnectTimeout(), SctpSocket::OnConnectTimeout(), TcpSocket::OnSocks4ConnectFailed(), TcpSocket::OnSocks4Read(), TcpSocket::OnWrite(), SctpSocket::OnWrite(), TcpSocket::Open(), and SctpSocket::Open().

{
        if (x != m_bConnecting)
        {
                m_bConnecting = x;
                if (x)
                {
                        SetTimeout( GetConnectTimeout() );
                }
                else
                {
                        SetTimeout( 0 );
                }
        }
}

bool StreamSocket::Connecting

(

)

Check connecting flag.

Returns:

true if the socket is still trying to connect

Definition at line 76 of file StreamSocket.cpp.

References m_bConnecting.

Referenced by HttpGetSocket::HttpGetSocket(), TcpSocket::OnWrite(), SctpSocket::OnWrite(), Ready(), and TcpSocket::SendBuf().

{
        return m_bConnecting;
}

bool StreamSocket::Ready

(

)

[virtual]

Returns true when socket file descriptor is valid, socket connection is established, and socket is not about to be closed.

Reimplemented from Socket.

Definition at line 82 of file StreamSocket.cpp.

References Socket::CloseAndDelete(), Connecting(), Socket::GetSocket(), and INVALID_SOCKET.

Referenced by TcpSocket::OnRead(), and TcpSocket::SendBuf().

{
        if (GetSocket() != INVALID_SOCKET && !Connecting() && !CloseAndDelete())
                return true;
        return false;
}

void StreamSocket::SetConnectTimeout

(

int

x

)

Set timeout to use for connection attempt.

Parameters:

x

Timeout in seconds

Definition at line 90 of file StreamSocket.cpp.

References m_connect_timeout.

{
        m_connect_timeout = x;
}

int StreamSocket::GetConnectTimeout

(

)

Return number of seconds to wait for a connection.

Returns:

Connection timeout (seconds)

Definition at line 96 of file StreamSocket.cpp.

References m_connect_timeout.

Referenced by SetConnecting().

{
        return m_connect_timeout;
}

void StreamSocket::SetFlushBeforeClose

(

bool

x = true

)

Set flush before close to make a tcp socket completely empty its output buffer before closing the connection.

Definition at line 102 of file StreamSocket.cpp.

References m_flush_before_close.

Referenced by TcpSocket::OnRead(), and TcpSocket::TryWrite().

{
        m_flush_before_close = x;
}

bool StreamSocket::GetFlushBeforeClose

(

)

Check flush before status.

Returns:

true if the socket should send all data before closing

Definition at line 108 of file StreamSocket.cpp.

References m_flush_before_close.

{
        return m_flush_before_close;
}

void StreamSocket::SetConnectionRetry

(

int

n

)

Define number of connection retries (tcp only).

n = 0 - no retry n > 0 - number of retries n = -1 - unlimited retries

Definition at line 120 of file StreamSocket.cpp.

References m_connection_retry.

{
        m_connection_retry = x;
}

int StreamSocket::GetConnectionRetry

(

)

Get number of maximum connection retries (tcp only).

Definition at line 114 of file StreamSocket.cpp.

References m_connection_retry.

Referenced by TcpSocket::OnConnectTimeout(), SctpSocket::OnConnectTimeout(), TcpSocket::OnWrite(), and SctpSocket::OnWrite().

{
        return m_connection_retry;
}

void StreamSocket::IncreaseConnectionRetries

(

)

Increase number of actual connection retries (tcp only).

Definition at line 132 of file StreamSocket.cpp.

References m_retries.

Referenced by TcpSocket::OnConnectTimeout(), and SctpSocket::OnConnectTimeout().

{
        m_retries++;
}

int StreamSocket::GetConnectionRetries

(

)

Get number of actual connection retries (tcp only).

Definition at line 126 of file StreamSocket.cpp.

References m_retries.

Referenced by TcpSocket::OnConnectTimeout(), SctpSocket::OnConnectTimeout(), TcpSocket::OnWrite(), and SctpSocket::OnWrite().

{
        return m_retries;
}

void StreamSocket::ResetConnectionRetries

(

)

Reset actual connection retries (tcp only).

Definition at line 138 of file StreamSocket.cpp.

References m_retries.

{
        m_retries = 0;
}

void StreamSocket::SetCallOnConnect

(

bool

x = true

)

Instruct socket to call OnConnect callback next sockethandler cycle.

Definition at line 144 of file StreamSocket.cpp.

References ISocketHandler::AddList(), Socket::GetSocket(), Socket::Handler(), LIST_CALLONCONNECT, and m_call_on_connect.

Referenced by TcpSocket::OnWrite(), SctpSocket::OnWrite(), and TcpSocket::Open().

{
        Handler().AddList(GetSocket(), LIST_CALLONCONNECT, x);
        m_call_on_connect = x;
}

bool StreamSocket::CallOnConnect

(

)

Check call on connect flag.

Returns:

true if OnConnect() should be called a.s.a.p

Definition at line 151 of file StreamSocket.cpp.

References m_call_on_connect.

{
        return m_call_on_connect;
}

void StreamSocket::SetRetryClientConnect

(

bool

x = true

)

Set flag to initiate a connection attempt after a connection timeout.

Definition at line 157 of file StreamSocket.cpp.

References ISocketHandler::AddList(), Socket::GetSocket(), Socket::Handler(), LIST_RETRY, and m_b_retry_connect.

Referenced by TcpSocket::OnConnectTimeout(), SctpSocket::OnConnectTimeout(), and TcpSocket::OnSocks4ConnectFailed().

{
        Handler().AddList(GetSocket(), LIST_RETRY, x);
        m_b_retry_connect = x;
}

bool StreamSocket::RetryClientConnect

(

)

Check if a connection attempt should be made.

Returns:

true when another attempt should be made

Definition at line 164 of file StreamSocket.cpp.

References m_b_retry_connect.

{
        return m_b_retry_connect;
}

void StreamSocket::SetLineProtocol

(

bool

x = true

)

[virtual]

Called after OnRead if socket is in line protocol mode.

See also:

SetLineProtocol Enable the OnLine callback. Do not create your own OnRead callback when using this.

Reimplemented in TcpSocket.

Definition at line 170 of file StreamSocket.cpp.

References m_line_protocol.

Referenced by TcpSocket::SetLineProtocol().

{
        m_line_protocol = x;
}

bool StreamSocket::LineProtocol

(

)

Check line protocol mode.

Returns:

true if socket is in line protocol mode

Definition at line 176 of file StreamSocket.cpp.

References m_line_protocol.

Referenced by TcpSocket::OnRead().

{
        return m_line_protocol;
}

void StreamSocket::SetShutdown

(

int

x

)

Set shutdown status.

Definition at line 182 of file StreamSocket.cpp.

References m_shutdown.

Referenced by TcpSocket::OnRead().

{
        m_shutdown = x;
}

int StreamSocket::GetShutdown

(

)

Get shutdown status.

Definition at line 188 of file StreamSocket.cpp.

References m_shutdown.

Referenced by TcpSocket::Close().

{
        return m_shutdown;
}

virtual int StreamSocket::Protocol

(

)

[pure virtual]

Returns IPPROTO_TCP or IPPROTO_SCTP.

Implemented in SctpSocket, and TcpSocket.

StreamSocket& StreamSocket::operator=

(

const StreamSocket &

)

[inline, private]

Definition at line 137 of file StreamSocket.h.

{ return *this; } // assignment operator

---

Member Data Documentation

bool StreamSocket::m_bConnecting [private]

Flag indicating connection in progress.

Definition at line 139 of file StreamSocket.h.

Referenced by Connecting(), and SetConnecting().

int StreamSocket::m_connect_timeout [private]

Connection timeout (seconds).

Definition at line 140 of file StreamSocket.h.

Referenced by GetConnectTimeout(), and SetConnectTimeout().

bool StreamSocket::m_flush_before_close [private]

Send all data before closing (default true).

Definition at line 141 of file StreamSocket.h.

Referenced by GetFlushBeforeClose(), and SetFlushBeforeClose().

int StreamSocket::m_connection_retry [private]

Maximum connection retries (tcp).

Definition at line 142 of file StreamSocket.h.

Referenced by GetConnectionRetry(), and SetConnectionRetry().

int StreamSocket::m_retries [private]

Actual number of connection retries (tcp).

Definition at line 143 of file StreamSocket.h.

Referenced by GetConnectionRetries(), IncreaseConnectionRetries(), and ResetConnectionRetries().

bool StreamSocket::m_call_on_connect [private]

OnConnect will be called next ISocketHandler cycle if true.

Definition at line 144 of file StreamSocket.h.

Referenced by CallOnConnect(), and SetCallOnConnect().

bool StreamSocket::m_b_retry_connect [private]

Try another connection attempt next ISocketHandler cycle.

Definition at line 145 of file StreamSocket.h.

Referenced by RetryClientConnect(), and SetRetryClientConnect().

bool StreamSocket::m_line_protocol [private]

Line protocol mode flag.

Definition at line 146 of file StreamSocket.h.

Referenced by LineProtocol(), and SetLineProtocol().

int StreamSocket::m_shutdown [private]

Shutdown status.

Definition at line 147 of file StreamSocket.h.

Referenced by GetShutdown(), and SetShutdown().

---

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

• StreamSocket.h
• StreamSocket.cpp