Name |
Data type |
Accessing |
Description |
---|---|---|---|
BytesAvailableToRead |
UDINT |
Read |
Indicates the number of bytes in the receive buffer available to be read using the Receive method. (Range: 0 ... 2147483647) |
IsReadable |
BOOL |
Read |
Indicates that data has been received that has not yet been processed by the Receive method. |
IsWritable |
BOOL |
Read |
Indicates that the connection is in a state where data can be sent to the server. |
Result |
ET_Result |
Read |
Indicates the result of the last method call. If the result is different than Ok, the value is not overwritten not even a method is called. |
State |
ET_State |
Read |
Indicates the state of the socket. |
TotalBytesReceived |
ULINT |
Read |
Counts the total number of bytes received. (Range: 1 ... 264-1) |
TotalBytesSent |
ULINT |
Read |
Counts the total number of bytes sent. (Range: 1 ... 264-1) |
SockOpt_Broadcast |
BOOL |
Read/write |
Allows you to send broadcast packets via that UDP socket. If FALSE, the Send method returns an error message when sending UDP broadcast messages. |
SockOpt_MulticastDefaultInterface |
STRING(15)] |
Read/write |
Allows you to specify the IP address of the interface that is used to send multicast messages when no action has been performed that caused the socket to be bound. |
SockOpt_MulticastLoopback |
BOOL |
Read/write |
If set to TRUE, multicast messages sent are also copied to the receive buffer as if they had been sent by an external UDP peer. |
SockOpt_MulticastTTL |
SINT |
Read/write |
Specifies the time to live (TTL) of multicast messages sent. This value can affect the scope of where the packages are forwarded to. (Range: 0 ... 255) |
SockOpt_ReceiveBufferSize |
UDINT |
Read/write |
Sets the receive buffer size of the UDP stack. It should always be greater than the amount of data received at one time to help avoid data loss. (Range: 1 ... 2147483647) |
SockOpt_SendBufferSize |
UDINT |
Read/write |
Sets the send buffer size of the UDP stack. It should always be greater than the amount of data sent at one time to help avoid errors. (Range: 1 ... 2147483647) |