BTCommInterfaces.pas File Reference

Typedefs
typedef void(*	TBTDataAvailableEvent) (const IStompFrame AStompFrame)

Functions
TNotifyEvent	GetOnConnected ()
	SetOnAfterTransportConnected (TNotifyEvent Value)
TNotifyEvent	GetOnAfterTransportConnected ()
	SetOnDataAvailable (TBTDataAvailableEvent Value)
TBTDataAvailableEvent	GetOnDataAvailable ()
	SetConnectTimeOut (Integer Value)
Integer	GetConnectTimeOut ()
	SetClientHeartBeatInterval (Integer Value)
Integer	GetClientHeartBeatInterval ()
	SetServerHeartBeatInterval (Integer Value)
Integer	GetServerHeartBeatInterval ()
TStompProtocolVersion	GetStompVersion ()
	SetStompVersion (TStompProtocolVersion Value)
	SetURI (const IURI Value)
IURI	GetURI ()
Boolean	GetConnectTimeOutSpecifiedManually ()
	SetConnectTimeOutSpecifiedManually (const Boolean Value)
	Connect ()
Boolean	SupportsProtocol (const string ProtocolName)
	StompDisconnect ()
Boolean	TransportConnected ()
string	GetURIParam (const string AKey)
	ReadOneMessage ()
	ReadOneMessage (const Integer TimeOut, const Boolean TimeOutException=False)
	ReadOneMessageNoWait ()
	StompTransmit (const RawByteString Value, const Integer SendTimeOut=TCP_DEFAULT_SEND_TIMEOUT)
string	AdapterName ()
	SendHeartbeat ()
	CheckHeartbeat ()
Boolean	ServerExpectsHeartBeat ()
Boolean	ServerSendsHeartBeats ()
	StoreHeartbeatTimestamp ()
Boolean	ReceiveHeartbeat (Integer ATimeOut)
Boolean	IsMinStompVersion (const TStompProtocolVersion AVersion)
	CheckMinStompVersion (const TStompProtocolVersion AVersion)

Variables
const	TCP_DEFAULT_SEND_TIMEOUT = -1
Integer	ConnectTimeOut
Boolean	ConnectTimeOutSpecifiedManually
TStompProtocolVersion	StompVersion
Integer	ClientHeartBeatInterval
Integer	ServerHeartBeatInterval
IURI	URI
TNotifyEvent	OnConnected
TBTDataAvailableEvent	OnDataAvailable
	end

Typedef Documentation

TBTDataAvailableEvent

typedef void(* TBTDataAvailableEvent) (const IStompFrame AStompFrame)

Function Documentation

AdapterName()

string AdapterName

(

)

CheckHeartbeat()

CheckHeartbeat

(

)

CheckMinStompVersion()

CheckMinStompVersion

(

const TStompProtocolVersion

AVersion

)

Connect()

Connect

(

)

GetClientHeartBeatInterval()

Integer GetClientHeartBeatInterval

(

)

GetConnectTimeOut()

Integer GetConnectTimeOut

(

)

GetConnectTimeOutSpecifiedManually()

Boolean GetConnectTimeOutSpecifiedManually

(

)

GetOnAfterTransportConnected()

TNotifyEvent GetOnAfterTransportConnected

(

)

GetOnConnected()

TNotifyEvent GetOnConnected

(

)

GetOnDataAvailable()

TBTDataAvailableEvent GetOnDataAvailable

(

)

GetServerHeartBeatInterval()

Integer GetServerHeartBeatInterval

(

)

GetStompVersion()

TStompProtocolVersion GetStompVersion

(

)

GetURI()

IURI GetURI

(

)

GetURIParam()

string GetURIParam

(

const string

AKey

)

IsMinStompVersion()

Boolean IsMinStompVersion

(

const TStompProtocolVersion

AVersion

)

ReadOneMessage() [1/2]

ReadOneMessage

(

)

ReadOneMessage() [2/2]

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

ReadOneMessageNoWait()

ReadOneMessageNoWait

(

)

ReceiveHeartbeat()

Boolean ReceiveHeartbeat

(

Integer

ATimeOut

)

SendHeartbeat()

SendHeartbeat

(

)

ServerExpectsHeartBeat()

Boolean ServerExpectsHeartBeat

(

)

ServerSendsHeartBeats()

Boolean ServerSendsHeartBeats

(

)

SetClientHeartBeatInterval()

SetClientHeartBeatInterval

(

Integer

Value

)

SetConnectTimeOut()

SetConnectTimeOut

(

Integer

Value

)

SetConnectTimeOutSpecifiedManually()

SetConnectTimeOutSpecifiedManually

(

const Boolean

Value

)

SetOnAfterTransportConnected()

SetOnAfterTransportConnected

(

TNotifyEvent

Value

)

SetOnDataAvailable()

SetOnDataAvailable

(

TBTDataAvailableEvent

Value

)

SetServerHeartBeatInterval()

SetServerHeartBeatInterval

(

Integer

Value

)

SetStompVersion()

SetStompVersion

(

TStompProtocolVersion

Value

)

SetURI()

SetURI

(

const IURI

Value

)

StompDisconnect()

StompDisconnect

(

)

StompTransmit()

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

StoreHeartbeatTimestamp()

StoreHeartbeatTimestamp

(

)

SupportsProtocol()

Boolean SupportsProtocol

(

const string

ProtocolName

)

TransportConnected()

Boolean TransportConnected

(

)

Variable Documentation

ClientHeartBeatInterval

Integer ClientHeartBeatInterval

See also

GetClientHeartBeatInterval For reading

SetClientHeartBeatInterval For writing

ConnectTimeOut

Integer ConnectTimeOut

See also

GetConnectTimeOut For reading

SetConnectTimeOut For writing

ConnectTimeOutSpecifiedManually

Boolean ConnectTimeOutSpecifiedManually

See also

GetConnectTimeOutSpecifiedManually For reading

SetConnectTimeOutSpecifiedManually For writing

end

end

OnConnected

TNotifyEvent OnConnected

See also

GetOnConnected For reading

SetOnConnected For writing

OnDataAvailable

TBTDataAvailableEvent OnDataAvailable

See also

GetOnDataAvailable For reading

SetOnDataAvailable For writing

ServerHeartBeatInterval

Integer ServerHeartBeatInterval

See also

GetServerHeartBeatInterval For reading

SetServerHeartBeatInterval For writing

StompVersion

TStompProtocolVersion StompVersion

See also

GetStompVersion For reading

SetStompVersion For writing

TCP_DEFAULT_SEND_TIMEOUT

const TCP_DEFAULT_SEND_TIMEOUT = -1

URI

IURI URI

See also

GetURI For reading

SetURI For writing