Carapace

X.25 Comms Module

The X25 module provides communications over X.25. It sits at the bottom of a communications stack.

Currently, the only supported X.25 card manufacturer is Eicon.

X.25 Creation

To make X.25 available, load the library carax25.dll as follows:

    (loadLibrary "carax25")

The create function can be used to create a X25 module eg.

    (create X25)
Once created, this module is tailored using its properties and methods.

An X25 module is often created in the process of creating a comms stack by using the function buildCommsStack.

X.25 Properties

A X25 module supports the following properties:

property name property type description
port Integer the port number on the local X.25 card
localDte String the address at the local end of the X.25 communications
remoteDte String the address at the remote end of the X.25 communications -- this is the 'called' address
log Log a log attached to the communications channel
userData Binary the user data sent with a connect request or received from a connect request
facilities Binary the facililites sent with a connect request or received from a connect request
moreToReceive String determines if there is more data to receive -- this may be due to the more-bit being set on the received X.25 packet or if the received packet is larger than the supplied buffer size, so that a subsequent receive will pick up more of the data
sendBufferSize Integer size of the buffer used for sending X.25 data
receiveBufferSize Integer size of the buffer used for receiving X.25 data
connectTimeout Integer number of milliseconds to wait for the X.25 call confirm packet
sendTimeout Integer number of milliseconds to wait for the X.25 card to send a packet
disconnectTimeout Integer number of milliseconds to wait for the X.25 clear confirm packet
cancelTimeout Integer number of milliseconds to wait for the X.25 card to cancel a request
connectionId Integer identifies the current X.25 when connected
cause Integer the X.25 cause (reason) code which is carried on a disconnect
diagnostic Integer the X.25 diagnostic code which is carried on a disconnect

X.25 Methods

The X25 module supports the following methods:

method name description
describeCause return a text description of the X.25 disconnection cause
describeDiagnostic return a text description of the X.25 disconnection diagnostic

The standard comms module methods are also supported:

method name description
connect connect this module
receive receive data
receiveInto receive data into the supplied buffer
send send data
disconnect disconnect this module
bind bind address information for this module
listen prepare to listen for new connections
accept wait for a new connection to arrive and, if it does, accept it


describeCause

Return a text description of the X.25 disconnection cause.

Arguments:

causeInteger

Return type: String is returned.


describeDiagnostic

Return a text description of the X.25 disconnection diagnostic.

Arguments:

diagnosticInteger

Return type: String is returned.


Contents Index Current topic: communications Related topics: communications classes, objects