195.5.2.1 Tracepoint TPI

 
Table 17
Structure of the TPI trace record
Offset
Data item
Size
Comment
0
IP address of remote host
4 Bytes
 
 
Byte order is BIG ENDIAN
4
local port
2 Bytes
6
remote port
2 Bytes
8
called TPI function
2 Bytes
 
See Table 18
10
return code of called function
2 Bytes
12
additional parameter
2 Bytes
 
dependent on called function See Table 19
14
additional data array
...
max. 40 Bytes
 
Table 18
TPI function identifier and TPI returncodes
TPI function identifier
TPI returncodes
Value
Meaning
Value
Meaning
0x012E
TPI_LISTEN
0x0000
GOOD
0x012F
TPI_CONNECT
0x0028
RESOURCE_BUSY
0x0130
TPI_ACCEPT
0x0029
WOULD_BLOCK
0x0131
TPI_SEND
0x002A
CONN_LOSS
0x0132
TPI_RECEIVE
0x002B
TIMEOUT
0x0133
TPI_CLOSE
0x002C
DUMMY_CALLED
0x0134
TPI_SET_OPTION
0x002D
BAD_PARAM
0x0135
TPI_SET_MAILBOX
0x002E
FATAL_INTERNAL
0x0136
TPI_GET_OPTION
 
 
 
Table 19
Additional parameter & additional data
called function
add_param
add_data
len
TPI_LISTEN
none
NULL
0
TPI_CONNECT
none
NULL
0
TPI_ACCEPT
none
address info of remote host
16
TPI_SEND
bytes delivered for transmit
user data to be transferred
<= 40
TPI_RECEIVE
bytes received by the user
user data received by the user
<= 40
TPI_CLOSE
none
NULL
0
TPI_SET_OPTION
high byte: option group
low byte: option; see Table 21
first byte: action set(1)/reset(0)
other 2 bytes: option value
3
TPI_SET_MAILBOX
none
async message to be send to mailbox by TCP; see Figure 68
33
TPI_GET_OPTION
high byte: option group
low byte: option; see Table 21
first byte: action set(1)/reset(0)
other 2 bytes: option value
3
 
Table 20
Structure of ASYNC message
Offset
Data Item
Size
Comment
0
user data
16
defined by the user
16
Pointer to socket
4
pointer to the socket descriptor
20
socket identification
4
see <Betonung>Trace Socket Table on page 2540
24
message type
1
see Table 22
25
application tag
2
set by the user calling tpi_set_option (ROL_OPT_STD_CMS_COMM)
27
function identifier
2
identifier and return code of last called TPI function; see Table 18
29
return code
2
31
info word
2
bytes sent/received or error information
 
Table 21
Option groups and options
Option Group
Option
Value
Description
Value
Description
0X00
OL_LEVEL_DUMMY
 
No option defined
0X01
OL_LEVEL_IPPROTO
0X00
OL_IPPROTO_DUMMY
0X01
OL_IPPROTO_NODELAY
0X02
OL_LEVEL_SOL_SOCKET
0X00
OL_SOL_SOCKET_DUMMY
0X01
OL_SOL_SOCKET_SO_DEBUG
0X02
OL_SOL_SOCKET_SO_KEEPALIVE
0X03
OL_SOL_SOCKET_SO_DONTROUTE
0X04
OL_SOL_SOCKET_SO_LINGER
0X05
OL_SOL_SOCKET_SO_OOBINLINE
0X06
OL_SOL_SOCKET_SO_RCVBUF
0X07
OL_SOL_SOCKET_SO_SNDBUF
0X08
OL_SOL_SOCKET_SO_REUSEADDR
0X09
OL_SOL_SOCKET_SO_RCVLOWAT
0X0A
OL_SOL_SOCKET_SO_SNDLOWAT
0X0B
OL_SOL_SOCKET_SO_RCVTIMEO
0X0C
OL_SOL_SOCKET_SO_SNDTIMEO
0X0D
OL_SOL_SOCKET_SO_USELOOPBACK
0X0E
OL_SOL_SOCKET_SO_ERROR
0X03
OL_LEVEL_FCNTL
0X00
OL_FCNTL_DUMMY
 
0X01
OL_FCNTL_FNDELAY
0X02
OL_FCNTL_FASYNC
0X04
OL_LEVEL_IOCTL
 
No option defined
0X05
OL_LEVEL_ROLM
0X00
OL_ROLM_OPT_DUMMY
 
0X01
OL_ROLM_OPT_OS_COMM
0X02
OL_ROLM_OPT_APPL_TAG
0X03
OL_ROLM_OPT_MBUF_DATA_SIZE
0X04
OL_ROLM_OPT_CLUSTER_SIZE
0X05
OL_ROLM_OPT_MTU_SIZE_MIN_HEAD
0X06
OL_ROLM_OPT_STD_CMS_COMM
 
Table 22
Asynchronous message types
Value
Message Type
Description
0X01
ASYNC_MSG_ERROR
Some kind of fatal error has occurred on this socket.
0X02
ASYNC_MSG_ACCEPT_READY
The socket has a connection pending.
0X03
ASYNC_MSG_CONNECT_READY
The previously initiated connection call has completed.
0X04
ASYNC_MSG_WRITE_READY
Space is available in the socket output buffer.
Note that this message is never sent if the socket is in OS communications mode.
0X05
ASYNC_MSG_READ_READY
Data is available in the socket input buffer. Note that this message is sent for every incoming data segment received.
Note that this message is never sent if the socket is in OS communications mode.
0X06
ASYNC_MSG_CONN_LOSS
The connection has been lost on this socket.
0X07
ASYNC_MSG_OOB_DATA
Out of Band data is coming in on this socket.
OpenScape 4000 V10, Volume 1: AMO Descriptions, Service Documentation, Issue 5, ID: P31003H31A0S107057620
 © 09/2025 Mitel Networks Corporation. -  All rights reserved.
 Mitel and the Mitel logo are trademarks of Mitel Networks Corporation. Unify and associated marks are trademarks of Unify Software and Solutions GmbH&Co. KG. All other trademarks herein are the property of their respective owners.