Declaration

TnxBaseTransport = class(TnxStateComponent)

 
Description

The base class for all transports.

 
Events

OnAddSession

OnAddSession is called every time a session connects to the transport if it is in listening mode.

OnChooseServer

OnChooseServer is called in sending mode, if more than one server was found for broadcast

OnConnectionLost

OnConnectionLost is called if the transport detects a drop of a connection.

OnFindServers

OnFindServers is called before and after broadcasting for servers.

OnRemoveSession

OnAddSession is called every time a session disconnects from a transport if it is in listening mode.

 
Methods

Broadcast

This function initiates a broadcast for servers.

btDoCallBack

This function executes a callback function with the given parameters.

ClearStats

This function resets all statistics for the transport.

ConnectionCount

This function returns the number of physical connections.

Create

constructor.

CurrentTransport

This function returns the currently active transport.

Destroy

destructor.

EstablishConnection

This function establishes a connection and returns the session id. This function sends a request to the server and then waits for the reply.

GetBoundAddresses

This function returns a list of addresses for the transport.

GetName

This function returns the name of the transport.

GetServerNames

This function returns the addresses of all servers found for the current transport by using broadcast. aTimeOut specifies the timeout in msec for the broadcast.

GetStatsCaptions

This function returns the captions for the statistics items.

GetStatsValues

This function returns the values for the statistics items.

IsConnected

IsConnected returns true if the current transport has an open connection.

LoadSettingsFromStream

This function loads the Transport settings from a stream using aReader.

Post

This functions posts a request and does NOT wait for the answer.

ProtocolName

This function returns the name of the transport.

Reply

This function is called to reply to a request

Request

This functions sends a request and waits for the answer.

ResetMsgCount

This function sets the MsgCount stats to 0.

SaveSettingsToStream

This function saves the Transport settings to a stream using aWriter.

Sleep

This function forces the transport to sleep for aTimeOut msec.

Supported

This function returns true if the transport is supported in the current environment (e.g. windows version)

TerminateConnection

This function closes a connection.

Write

This functions transfers the given information to the other connection point by wrapping it into a TnxDataMessage and sending it over an open connection.

 
Properties

ActualBytesReceived

The number of bytes received since the last clearing.

ActualBytesSent

The number of bytes sent since the last clearing.

CommandHandler

This property points to the connected Command Handler.

CompressTime

The total time used for compressing data.

EventLogOptions

The log options for the event.

MaxBytesPerSecond

This is a maximum bytes per second setting for the transport. It is experimental and helps to test the transport for slow connections.

MessagesReceived

The number of Messages received since the last clearing.

MessagesSent

The number of Messages sent since the last clearing.

Mode

The mode of the transport.

MsgCount

The total number of messages transferred.

PingTime

This is a minimum turnaround time setting in msec for the transport. It is experimental and helps to test the transport for slow connections.

RespondToBroadcasts

If the server is in listening it responds to broadcast requests if this property is set to true.

ServerName

The Server Name. If in listening mode it's the name of the clients have to connect to. In sending mode it's the name the transport gets connected to.

ServerNameDesigntime

This is the Server Name property at design time.

ServerNameRuntime

This is the Server Name property at runtime.

Timeout

The timeout of the transport in msec.

UncompressedBytesReceived

The number of bytes received after uncompression since the last clearing.

UncompressedBytesSent

The number of bytes sent after uncompression since the last clearing.

UncompressTime

The total time used for uncompressing data.

 
File

 
nxllTransport

Home | Site Contents | Documentation | NexusDB Manual V4 | Class Reference | Symbol Reference | Classes