196.6.4.1 Tracepoint TPI


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 29
10	return code of called function	2 Bytes	See Table 29
12	additional parameter	2 Bytes	dependent on called function See Table 37
14	additional data array ...	max. 40 Bytes	dependent on called function See Table 37

Table 29

TPI function identifier and TPI returncodes

TPI function identifier


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 30	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 Table 37	33
TPI_GET_OPTION	high byte: option group low byte: option; see Table 30	first byte: action set(1)/reset(0) other 2 bytes: option value	3


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 2586
24	message type	1	see Table 31
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 29
29	return code	2
31	info word	2	bytes sent/received or error information

Table 30

Option groups and options

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

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 31

Asynchronous message types

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.

${DocTitle}, ID: ${DocID}

© 02/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.