Port SERVICEACCESS - TCP-SERVER-SOCKET 🛈¶
socket-based TCP server
Stimulation¶
This port has no stimulus capabilities.
Properties 🛈¶
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
Receive buffer size |
1000 |
int |
Number of messages which can be recorded in the receive buffer (ring buffer) |
||
IP version |
IPv4 |
[IPv4, IPv6] |
string |
Selection of the IP version used |
|
Keep cyclic sending active |
☐ |
bool |
If the check mark is set, the cyclical sending of packets is only stopped at port stop or by the explicit call to ‘StopSendPacketCyclic’. Otherwise (default), the cyclic sending is already terminated at the end of the test. |
Jobs 🛈¶
ClearReceiveBuffer¶
Clears the ecu.test high-level receive buffer. Low-level buffers in the driver are not cleared.
CloseConnection¶
Closes opened TCP connection and prevents reconnect
ConnectionInfo¶
Provides IP address and port of connected network end point.
Parameterization
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
string |
Tuple of IP address (str) and port (int) or NotPresent |
ReceivePacket¶
Returns a packet from the receive buffer and removes it from there
Parameterization
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
string |
Return value as ByteStream or NotPresent |
ReceiveSomeIpMessage¶
Returns a packet from the receive buffer, interprets it and filters the MessageId if necessary. If MultipleResults are enabled, a list with more than one object might be returned. The packet will be removed from the receive buffer.
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
InterpretAs |
‘PacketSomeIp’ |
[‘PacketSomeIp’, ‘PacketSomeIpSd’] |
string |
Specifies which class a package is to be interpreted by. A packet is only returned if it could be successfully interpreted. |
|
MessageId |
object |
MessageIds which have to match for passing (empty / int / list with ints) |
|||
MultipleResults |
False |
[False, True] |
bool |
Boolean, if enabled a list with result objects will be returned |
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
string |
Return value of specified type, list of it or NotPresent |
SendPacket¶
Send data
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
Data |
string |
String, payload as a ByteStream |
StartAccepting¶
Starts accepting TCP connections
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
ListenPort |
30490 |
int |
Port for incoming TCP connections |
StartSendPacketCyclic¶
Starts cyclic Transmission of a specified message
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
CycleTime |
500 |
int |
Cycle time [ms] |
||
CyclicHandle |
int |
CyclicHandle can be defined manually. It must be an integer value greater than 0. Collision detection against already defined handles will not be performed. |
|||
Payload |
object |
Payload of the message to be sent cyclically. Either a byte stream can be specified directly or an object from a UserPyModule defined class. Further information on using the payload can be found in the help (Tool tracetronic: Ethernet). |
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
CyclicHandle |
int |
Handle for targeted deactivation of cyclic transmission of that particular message. |
StopSendPacketCyclic¶
Stops cyclic transmission
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
CyclicHandle |
int |
Handle of a message to stop its cyclic transmission. If None is specified, cyclic transmission of all messages is stopped. |