TBTAbstractCommAdapter Class Reference

Inheritance diagram for TBTAbstractCommAdapter:

Public Member Functions
	TBTAbstractCommAdapter ()
	~TBTAbstractCommAdapter ()
string	AdapterName ()
	Name of the communication adapter.
	ReadOneMessage ()
	ReadOneMessage (const Integer TimeOut, const Boolean TimeOutException=False)
	ReadOneMessageNoWait ()
IStompFrame	ReadFrame (Integer ATimeOut)
	ProcessFrame (const IStompFrame AStompFrame)
	SendHeartbeat ()
	CheckHeartbeat ()
Boolean	ReceiveHeartbeat (Integer ATimeOut)
	Try to receive server heartbeat.
Boolean	ServerExpectsHeartBeat ()
Boolean	ServerSendsHeartBeats ()
	StoreHeartbeatTimestamp ()
Boolean	IsMinStompVersion (const TStompProtocolVersion AVersion)
	CheckMinStompVersion (const TStompProtocolVersion AVersion)

Public Attributes
Integer	ConnectTimeOut
	Connect time out (in milliseconds).
Boolean	ConnectTimeOutSpecifiedManually
TStompProtocolVersion	StompVersion
Integer	ClientHeartBeatInterval
Integer	ServerHeartBeatInterval
IURI	URI

Protected Member Functions
	SetConnectTimeOut (Integer Value)
Integer	GetConnectTimeOut ()
TStompProtocolVersion	GetStompVersion ()
	SetStompVersion (TStompProtocolVersion Value)
	SetURI (const IURI Value)
IURI	GetURI ()
TBTDataAvailableEvent	GetOnDataAvailable ()
	SetOnDataAvailable (TBTDataAvailableEvent Value)
Boolean	GetConnectTimeOutSpecifiedManually ()
	SetConnectTimeOutSpecifiedManually (const Boolean Value)
TNotifyEvent	GetOnConnected ()
	SetOnConnected (TNotifyEvent Value)
	SetOnAfterTransportConnected (TNotifyEvent Value)
TNotifyEvent	GetOnAfterTransportConnected ()
	SetClientHeartBeatInterval (Integer Value)
Integer	GetClientHeartBeatInterval ()
	SetServerHeartBeatInterval (Integer Value)
Integer	GetServerHeartBeatInterval ()
	AssertServerSendsHeartBeats ()
	AssertTransportConnected ()
	AssertIsTrailingNull (Byte B)
	AssertIsTrailingLf (Byte B)
	CheckValidTimeOut (Integer ATimeOut)
string	ReadFirstHeaderLineSkippingHeartbeats (Integer ATimeOut)
string	ReadHeaderLine (Integer ATimeOut)
IStompFrame	ReadStompHeader (Integer ATimeOut)
RawByteString	ReadMessageBodyTerminated ()
RawByteString	ReadMessageBodyWithLength (Integer ALength)
	ReadTrailingNull ()
	ReadTrailingLf ()
Integer	StompCONNECTEDFrameTimeout ()
	Connect ()
	Establish a STOMP connection.
	AfterSocketConnected ()
Boolean	SupportsProtocol (const string ProtocolName)
	StompDisconnect ()
Boolean	TransportConnected ()
	StompTransmit (const RawByteString Value, const Integer SendTimeOut=TCP_DEFAULT_SEND_TIMEOUT)
	CheckTransportConnected ()
	TryConsumeHeartBeats (Integer ATimeOut)
	Consume heart-beats.
	BeforeConsumeHeartBeats (Integer ATimeOut)
string	GetURIParam (const string AKey)
	Get parameter AKey of the connection URI params.

Protected Attributes
Boolean	FTransportConnected
IStompDecoder	StompDecoder
Boolean	HeartbeatSeen
TBTDataAvailableEvent	OnDataAvailable
TNotifyEvent	OnConnected
Integer	DataTimeout

Constructor & Destructor Documentation

TBTAbstractCommAdapter()

TBTAbstractCommAdapter::TBTAbstractCommAdapter

(

)

~TBTAbstractCommAdapter()

TBTAbstractCommAdapter::~TBTAbstractCommAdapter

(

)

Member Function Documentation

AdapterName()

string TBTAbstractCommAdapter::AdapterName

(

)

Name of the communication adapter.

AfterSocketConnected()

TBTAbstractCommAdapter::AfterSocketConnected ( )

protected

AssertIsTrailingLf()

TBTAbstractCommAdapter::AssertIsTrailingLf ( Byte B )

protected

AssertIsTrailingNull()

TBTAbstractCommAdapter::AssertIsTrailingNull ( Byte B )

protected

AssertServerSendsHeartBeats()

TBTAbstractCommAdapter::AssertServerSendsHeartBeats ( )

protected

AssertTransportConnected()

TBTAbstractCommAdapter::AssertTransportConnected ( )

protected

BeforeConsumeHeartBeats()

TBTAbstractCommAdapter::BeforeConsumeHeartBeats ( Integer ATimeOut )

protected

CheckHeartbeat()

TBTAbstractCommAdapter::CheckHeartbeat

(

)

CheckMinStompVersion()

TBTAbstractCommAdapter::CheckMinStompVersion

(

const TStompProtocolVersion

AVersion

)

CheckTransportConnected()

TBTAbstractCommAdapter::CheckTransportConnected ( )

protected

CheckValidTimeOut()

TBTAbstractCommAdapter::CheckValidTimeOut ( Integer ATimeOut )

protected

Connect()

TBTAbstractCommAdapter::Connect ( )

protected

Establish a STOMP connection.

Exceptions

EMQException

if the connection could not be established

GetClientHeartBeatInterval()

Integer TBTAbstractCommAdapter::GetClientHeartBeatInterval ( )

protected

GetConnectTimeOut()

Integer TBTAbstractCommAdapter::GetConnectTimeOut ( )

protected

GetConnectTimeOutSpecifiedManually()

Boolean TBTAbstractCommAdapter::GetConnectTimeOutSpecifiedManually ( )

protected

GetOnAfterTransportConnected()

TNotifyEvent TBTAbstractCommAdapter::GetOnAfterTransportConnected ( )

protected

GetOnConnected()

TNotifyEvent TBTAbstractCommAdapter::GetOnConnected ( )

protected

GetOnDataAvailable()

TBTDataAvailableEvent TBTAbstractCommAdapter::GetOnDataAvailable ( )

protected

GetServerHeartBeatInterval()

Integer TBTAbstractCommAdapter::GetServerHeartBeatInterval ( )

protected

GetStompVersion()

TStompProtocolVersion TBTAbstractCommAdapter::GetStompVersion ( )

protected

GetURI()

IURI TBTAbstractCommAdapter::GetURI ( )

protected

GetURIParam()

string TBTAbstractCommAdapter::GetURIParam ( const string AKey )

protected

Get parameter AKey of the connection URI params.

IsMinStompVersion()

Boolean TBTAbstractCommAdapter::IsMinStompVersion

(

const TStompProtocolVersion

AVersion

)

ProcessFrame()

TBTAbstractCommAdapter::ProcessFrame

(

const IStompFrame

AStompFrame

)

ReadFirstHeaderLineSkippingHeartbeats()

string TBTAbstractCommAdapter::ReadFirstHeaderLineSkippingHeartbeats ( Integer ATimeOut )

protected

ReadFrame()

IStompFrame TBTAbstractCommAdapter::ReadFrame

(

Integer

ATimeOut

)

ReadHeaderLine()

string TBTAbstractCommAdapter::ReadHeaderLine ( Integer ATimeOut )

protected

ReadMessageBodyTerminated()

RawByteString TBTAbstractCommAdapter::ReadMessageBodyTerminated ( )

protected

ReadMessageBodyWithLength()

RawByteString TBTAbstractCommAdapter::ReadMessageBodyWithLength ( Integer ALength )

protected

ReadOneMessage() [1/2]

TBTAbstractCommAdapter::ReadOneMessage

(

)

ReadOneMessage() [2/2]

TBTAbstractCommAdapter::ReadOneMessage	(	const Integer	TimeOut,
		const Boolean	TimeOutException = False )

ReadOneMessageNoWait()

TBTAbstractCommAdapter::ReadOneMessageNoWait

(

)

ReadStompHeader()

IStompFrame TBTAbstractCommAdapter::ReadStompHeader ( Integer ATimeOut )

protected

ReadTrailingLf()

TBTAbstractCommAdapter::ReadTrailingLf ( )

protected

ReadTrailingNull()

TBTAbstractCommAdapter::ReadTrailingNull ( )

protected

ReceiveHeartbeat()

Boolean TBTAbstractCommAdapter::ReceiveHeartbeat

(

Integer

ATimeOut

)

Try to receive server heartbeat.

Parameters

ATimeOut

time to wait. Value must be greater than zero.

Returns

True if a heart beat has been read

SendHeartbeat()

TBTAbstractCommAdapter::SendHeartbeat

(

)

ServerExpectsHeartBeat()

Boolean TBTAbstractCommAdapter::ServerExpectsHeartBeat

(

)

ServerSendsHeartBeats()

Boolean TBTAbstractCommAdapter::ServerSendsHeartBeats

(

)

SetClientHeartBeatInterval()

TBTAbstractCommAdapter::SetClientHeartBeatInterval ( Integer Value )

protected

SetConnectTimeOut()

TBTAbstractCommAdapter::SetConnectTimeOut ( Integer Value )

protected

SetConnectTimeOutSpecifiedManually()

TBTAbstractCommAdapter::SetConnectTimeOutSpecifiedManually ( const Boolean Value )

protected

SetOnAfterTransportConnected()

TBTAbstractCommAdapter::SetOnAfterTransportConnected ( TNotifyEvent Value )

protected

SetOnConnected()

TBTAbstractCommAdapter::SetOnConnected ( TNotifyEvent Value )

protected

SetOnDataAvailable()

TBTAbstractCommAdapter::SetOnDataAvailable ( TBTDataAvailableEvent Value )

protected

SetServerHeartBeatInterval()

TBTAbstractCommAdapter::SetServerHeartBeatInterval ( Integer Value )

protected

SetStompVersion()

TBTAbstractCommAdapter::SetStompVersion ( TStompProtocolVersion Value )

protected

SetURI()

TBTAbstractCommAdapter::SetURI ( const IURI Value )

protected

StompCONNECTEDFrameTimeout()

Integer TBTAbstractCommAdapter::StompCONNECTEDFrameTimeout ( )

protected

StompDisconnect()

TBTAbstractCommAdapter::StompDisconnect ( )

protected

StompTransmit()

TBTAbstractCommAdapter::StompTransmit ( const RawByteString Value, const Integer SendTimeOut = TCP_DEFAULT_SEND_TIMEOUT )

protected

StoreHeartbeatTimestamp()

TBTAbstractCommAdapter::StoreHeartbeatTimestamp

(

)

SupportsProtocol()

Boolean TBTAbstractCommAdapter::SupportsProtocol ( const string ProtocolName )

protected

TransportConnected()

Boolean TBTAbstractCommAdapter::TransportConnected ( )

protected

TryConsumeHeartBeats()

TBTAbstractCommAdapter::TryConsumeHeartBeats ( Integer ATimeOut )

protected

Consume heart-beats.

Parameters

ATimeOut

time to wait. Value be greater than zero.

Member Data Documentation

ClientHeartBeatInterval

Integer TBTAbstractCommAdapter::ClientHeartBeatInterval

See also

GetClientHeartBeatInterval For reading

SetClientHeartBeatInterval For writing

ConnectTimeOut

Integer TBTAbstractCommAdapter::ConnectTimeOut

Connect time out (in milliseconds).

Only implemented in Internet Direct (Indy) and Synapse.

See also

GetConnectTimeOut For reading

SetConnectTimeOut For writing

ConnectTimeOutSpecifiedManually

Boolean TBTAbstractCommAdapter::ConnectTimeOutSpecifiedManually

See also

GetConnectTimeOutSpecifiedManually For reading

SetConnectTimeOutSpecifiedManually For writing

DataTimeout

Integer TBTAbstractCommAdapter::DataTimeout

protected

See also

GetDataTimeout For reading

FTransportConnected

Boolean TBTAbstractCommAdapter::FTransportConnected

protected

HeartbeatSeen

Boolean TBTAbstractCommAdapter::HeartbeatSeen

protected

OnConnected

TNotifyEvent TBTAbstractCommAdapter::OnConnected

protected

See also

GetOnConnected For reading

SetOnConnected For writing

OnDataAvailable

TBTDataAvailableEvent TBTAbstractCommAdapter::OnDataAvailable

protected

See also

GetOnDataAvailable For reading

SetOnDataAvailable For writing

ServerHeartBeatInterval

Integer TBTAbstractCommAdapter::ServerHeartBeatInterval

See also

GetServerHeartBeatInterval For reading

SetServerHeartBeatInterval For writing

StompDecoder

IStompDecoder TBTAbstractCommAdapter::StompDecoder

protected

StompVersion

TStompProtocolVersion TBTAbstractCommAdapter::StompVersion

See also

GetStompVersion For reading

SetStompVersion For writing

URI

IURI TBTAbstractCommAdapter::URI

See also

GetURI For reading

SetURI For writing