Raw socket port configuration commands

Note:

The speed command must be set to a value that supports raw sockets; see Serial interface configuration commands for the required information.

socket

Syntax

socket

Context

config>port>serial>rs232

Description

This command creates a raw socket on an RS-232 port.

The no form of the command deletes the socket from the serial port.

Default

n/a

rx

Syntax

rx

Context

config>port>serial>rs232>socket

Description

This command enables the context to configure parameters for data packets received over a serial port’s raw socket.

Default

n/a

eop

Syntax

eop

Context

config>port>serial>rs232>socket>rx

Description

This command enables the context to configure end of packet (EOP) parameters for data packets received over the raw socket.

Note:

An EOP is declared by whichever EOP condition is encountered first.

idle-timeout

Syntax

idle-timeout milliseconds

Context

config>port>serial>rs232>socket>rx>eop

Description

This command specifies how long a serial port can remain idle before an EOP is declared and the packet is sent over the raw socket.

Default

50 ms

Parameters

milliseconds

the length of time, in milliseconds, that a serial port can remain idle before an EOP is declared

Values

10 to 5000

length

Syntax

length bytes

Context

config>port>serial>rs232>socket>rx>eop

Description

This command specifies the number of characters (converted to bytes) received on the serial port that triggers the node to encapsulate the characters in an IP transport packet and send it over a VPRN service.

Default

1500

Parameters

bytes

the number of characters (in bytes) to trigger sending an IP transport packet

Values

1 to 1500

special-char

Syntax

special-char value

no special-char

Context

config>port>serial>rs232>socket>rx>eop

Description

This command specifies a special character that, if received on the serial port, declares EOP and triggers the node to encapsulate previously received queued characters in an IP transport packet and send it over a VPRN service.

Note:

Other than declaring the EOP, the special character is otherwise treated as regular data; that is, it is added to the packet.

The no form of the command disables checking for a special character.

Default

no special-char

Parameters

value

specifies the special character, in a decimal or hexadecimal format, that triggers end of packet

Values

0 to 255, or 0x00 to 0xFF

squelch-delay

Syntax

squelch-delay seconds

no squelch-delay

Context

config>port>serial>rs232>socket>rx

Description

This command specifies how long a serial port can receive a continuous data stream before an alarm is raised indicating that the serial port has locked up and triggering the squelching function.

The no form of the command disables the squelching function on the serial port.

Default

no squelch-delay

Parameters

seconds

the number of seconds that a serial port can receive data before the squelching function is triggered

Values

1 to 120

squelch-reset

Syntax

squelch-reset

Context

config>port>serial>rs232>socket>rx

Description

This command allows an operator to manually clear squelching on a serial port’s raw socket without having to configure a time limit on the squelching function.

Squelching can also be set to clear automatically after a time limit has been reached with the unsquelch-delay command.

Default

n/a

unsquelch-delay

Syntax

unsquelch-delay seconds

no unsquelch-delay

Context

config>port>serial>rs232>socket>rx

Description

This command clears squelching on a raw socket by setting a limit on the amount of time that squelching can remain active on the port. When the time limit is reached, the auto-clear function is enabled and the serial port’s raw socket is put back into a normal state.

Squelching can also be cleared manually with the squelch-reset command.

The no form of the command disables the auto-clear function on a serial port.

Default

no unsquelch-delay

Parameters

seconds

the number of seconds before the auto-clear function is activated

Values

1 to 120

tx

Syntax

tx

Context

config>port>serial>rs232>socket

Description

This command enables the context to configure parameters for data packets transmitted over a serial port’s raw socket.

inter-session-delay

Syntax

inter-session-delay milliseconds

Context

config>port>serial>rs232>socket>tx

Description

This command specifies a time delay that the node inserts between a session's data that is being transmitted over a serial port and the next queued session's data. The next session's data is not sent until the current session's data is sent and the inter-session-delay is reached.

Default

10 ms

Parameters

milliseconds

the time delay, in milliseconds, between a session's data that is being transmitted over a serial port and the next queued session's data

Values

0 to 5000