TCP Connection

Method: isOpen

Indicates whether the specified connection is opened.

Network mode:              TCP server, TCP client

Returns true if connection is opened, false if not.

Example:

    evesec call /SEC/__dev__ttyS0/net/1 connection.net.tcp isOpen

Returned value:

    boolean false

Method: switchedAt

Returns the date (in seconds from the Unix epoch) when the connection was switched.

Network mode:              TCP server, TCP client

Example:

    evesec call /SEC/__dev__ttyS0/net/1 connection.net.tcp switchedAt

Returned value:

    uint64 1266923077

Method: close

Closes active TCP connection.

Network mode:              TCP server, TCP client

Returns true if connection was closed, false if not.

Example:

    evesec call /SEC/__dev__ttyS0/net/1 connection.net.tcp close

Returned value:

    boolean true

Method: address

Returns the address of the remote side.

Network mode:              TCP server, TCP client

Example:

    evesec call /SEC/__dev__ttyS0/net/1 connection.net.tcp address

Returned value:

    string "192.168.0.1"

Method: port

Returns the port number of the remote side.

Network mode:              TCP server, TCP client

Example:

    evesec call /SEC/__dev__ttyS0/net/1 connection.net.tcp port

Returned value:

    uint16 46979

Method: localPort

Returns the port number of the localhost.

Network mode:              TCP server, TCP client

Example:

    evesec call /SEC/__dev__ttyS0/net/1 connection.net.tcp localPort

Returned value:

    uint16 5000

Method: authorisationUsed

Indicates whether a connection password was used while establishing TCP connection.

Network mode:              TCP server, TCP client

Returns true if authorisation was used, false if not.

Example:

    evesec call /SEC/__dev__ttyS0/net/1 connection.net.tcp authorisationUsed

Returned value:

    boolean true

Method: encryptionUsed

Indicates whether traffic encryption is used in TCP connection.

Network mode:              TCP server, TCP client

Returns true if encryption is used, false if not.

Example:

    evesec call /SEC/__dev__ttyS0/net/1 connection.net.tcp encryptionUsed

Returned value:

    boolean true

Property: reconnectTimeout

Controls period of time after which TCP client will try to restore connection if connection was dropped or unsuccessful connection attempt occurred.

Type:                      uint32 (u)
Network mode:              TCP client
Value limits:              > 0
Default value:             5000 ms

Property: handshakeTimeout

Controls period of time after which TCP connection will be dropped if handshake is not finished yet.

Handshake is used for encryption and authorisation.

Type:                      uint32 (u)
Network mode:              TCP client
Value limits:              > 0
Default value:             30000 ms
Note: For TCP server Network’s property is used.

 

Property: offlineBufferMaxSize

Controls maximum size of buffer where data arriving from the serial port is collected to, when TCP connection is not established.

Also note that when you decrease this value and the offline buffer already contains more data than you have specified, new value will be applied to the offline buffer only on the next data arrival from the serial port.

Type:                      uint32 (u)
Network mode:              TCP client
Default value:             4096 B
Note: For TCP server Network’s property is used.

 

Property: telnetReadAttrRight

Controls whether serial port attributes can be read by RFC 2217 methods.

Type:                      boolean (b)
Network mode:              TCP server, TCP client
Default value:             true

Property: telnetWriteAttrRight

Controls whether serial port attributes can be set by RFC 2217 methods.

Type:                      boolean (b)
Network mode:              TCP server, TCP client
Default value:             true

Property: telnetPing

Sets Telnet ping interval in milliseconds. If interval value is zero ping is disabled. Telnet ping is implemented via Telnet’s AYT (‘Are You There’) command.

Type:                      uint32 (u)
Network mode:              TCP server, TCP client
Value limits:              <= 86400000 ms (=24 hours)
Default value:             0 ms

Property: nagle

Controls Nagle’s algorithm of TCP streams.
Nagle’s algorithm prevents from sending multiple small packets by merging them into bigger ones instead.

Visit http://en.wikipedia.org/wiki/Nagle’s_algorithm for details.

Type:                      boolean (b)
Network mode:              TCP server, TCP client
Default value:             true

Property: keepAlive

Controls ‘keep alive’ feature of TCP streams.
‘Keep alive’ allows discovering TCP stream disconnection somewhere between peers.

We use non-default timeouts (i.e. keepAliveIdle and keepAliveInterval) to detect disconnections faster.

Visit http://en.wikipedia.org/wiki/Keepalive#TCP_Keepalive for details.

Type:                      boolean (b)
Network mode:              TCP server, TCP client
Default value:             true

Property: keepAliveIdle

Type:                      uint32 (u)
Network mode:              TCP server, TCP client
Condition:                 keepAlive is true
Value limits:              <= 604800 s
Default value:             7 s

Property: keepAliveInterval

Type:                      uint32 (u)
Network mode:              TCP server, TCP client
Condition:                 keepAlive is true
Value limits:              <= 86400 s
Default value:             1 s

Property: keepAliveCount

Type:                      uint32 (u)
Network mode:              TCP server, TCP client
Condition:                 keepAlive is true
Value limits:              <= 1000
Default value:             9

Property: dataSendRight

Together with dataReceiveRight, controls already established TCP connections’ traffic.

Type:                      boolean (b)
Network mode:              TCP server, TCP client
Default value:             true

Property: dataReceiveRight

Together with dataSendRight, controls already established TCP connections’ traffic.

Type:                      boolean (b)
Network mode:              TCP server, TCP client
Default value:             true

Method: bytesRead

Returns the amount of bytes received from network through this TCP connection.

Network mode:              TCP server, TCP client
Note: Handshake traffic (i.e. authorization and encryption negotiation) is counted as well.

Example:

    evesec call /SEC/__dev__ttyS0/net/1 connection.net.tcp bytesRead

Returned value:

    uint64 702

Method: bytesWritten

Returns the amount of bytes sent to network through this TCP connection.

Network mode:              TCP server, TCP client
Note: Handshake traffic (i.e. authorization and encryption negotiation) is counted as well.

Example:

    evesec call /SEC/__dev__ttyS0/net/1 connection.net.tcp bytesWritten

Returned value:

    uint64 117