1 # tcpcsy.pod

     2 #

     3 # Copyright (c) 2008-2010 Accenture. All rights reserved.

     4 # This component and the accompanying materials are made available

     5 # under the terms of the "Eclipse Public License v1.0"

     6 # which accompanies this distribution, and is available

     7 # at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 #

     9 # Initial Contributors:

    10 # Accenture - Initial contribution

    11 #

    12 

    13 __END__

    14 

    15 =head1 tcpcsy

    16 

    17 =head2 Introduction

    18 

    19 A C32 plug-in that provides serial port emulation over a TCP socket. The socket can be configured to either actively connect to its TCP peer, or to passively listen for a connection from the peer.

    20 

    21 =head2 Configuration

    22 

    23 Configuration of the ports is done via the Central Repository file 102836da.txt. This is expected to contain the following key space:

    24 

    25  Bits	 Supported Values    Meaning

    26 

    27  31-24	 0                   Port record. Port fields assigned as follows:

    28  23-16   0                   Socket mode (type int, 0 - active, 1 - passive)

    29          1                   Protocol family (type int)

    30          2                   Protocol (type int)

    31          3                   IP address (type string in valid form to be handled by TInetAddr::Input)

    32          4                   Port (type int, the port to connect to in active mode or the port to

    33                              listen on in passive mode)

    34  15-0    0-65535             C32 unit value

    35 

    36 For example:

    37 

    38  # Port 0

    39  0x00000000	int	0		# Active socket.

    40  0x00010000	int	0x0800		# KAfInet.

    41  0x00020000	int	6		# KProtocolInetTcp.

    42  0x00030000	string	127.0.0.1	# IP address.

    43  0x00040000	int	3030		# Port.

    44 

    45  # Port 1

    46  0x00000001	int	0		# Active socket.

    47  0x00010001	int	0x0800		# KAfInet.

    48  0x00020001	int	6		# KProtocolInetTcp.

    49  0x00030001	string	172.16.0.2	# IP address.

    50  0x00040001	int	3030		# Port.

    51 

    52 

    53 Note, the Central Repository file can be written to by any process with C<WriteDeviceData> capability. It is therefore possible to dynamically add new, and alter existing port configurations.

    54 

    55 =head1 Copyright

    56 

    57 Copyright (c) 2008-2010 Accenture. All rights reserved.

    58 

    59 =cut