Socket error codes

Socket error codes
ErrorID Code
SubErrorID Code
Error Description
Corrective Action
0
The Socket instruction successfully completed operation.
1
The Socket instruction is pending.
2
The Socket Instance is not available.
Confirm that the Socket Instance is not deleted or the Timeout value exceeded.
3
The SOCKET_DELETEALL operation is ongoing.
Wait for the pending SOCKET_DELETEALL operation to complete.
4
1
Illegal Parameter, Invalid Channel.
No action. Reserved for future use.
4
2
Illegal Parameter, Invalid Socket IP Address.
  • Error occurs. SOCKET_CREATE contains a SockAddr with any nonzero value.
  • SOCKET_OPEN or SOCKET_WRITE execute with an invalid target IP Address. Invalid target IP Addresses are:
    • Self IP Address
    • 0.0.0.0
    • Loop back Address (127.x.x.x)
    • Class D Multicast Address (224.x.x.x)
    • Local Link Address (169.254.x.x)
    • Broadcast Address (Only applicable for TCP Socket Instance)
Change to a valid IP address.
4
3
Illegal Parameter, Invalid Socket Port Address.
Error occurs when the following Ports are specified in SOCKET_CREATE, SOCKET_OPEN, or SOCKET_WRITE:
  • TCP Ports
    • 44818 - EtherNet/IP
    • 502 - ModbusTCP
    • 67 - DHCP Server
    • 68 - DHCP Client
    • 0 -  Invalid Port 
  • UDP Ports
    • 2222 - EtherNet/IP
    • 67 - DHCP Server
    • 68 - DHCP Client
    • 0 - Invalid Port
Change the Port Address.
4
4
Illegal Parameter, Invalid Socket Type.
Valid Socket Types are:
  • TCP - 1
  • UDP - 2
Change Socket Type.
4
5
Illegal Parameter, Invalid Socket Timeout value.
Valid Timeout values are:
  • SOCKET_CREATE, SOCKET_ACCEPT, and SOCKET_READ:
  • 0 (Default), or any value between 1000 and 86400000ms.
  • SOCKET_OPEN and SOCKET_WRITE:
  • 0 (Default), or any value between 1000 and 86400000ms.
Change the Timeout value to a valid value.
4
6
Illegal Parameter, Invalid Socket Instance.
  • TCP Server Socket Type:
  • Use the Socket Instance returned in SOCKET_ACCEPT for SOCKET_WRITE, SOCKET_READ, SOCKET_DELETE, and SOCKET_INFO.
  • UDP Socket and TCP Client Socket Types:
  • Use the Socket Instance returned in SOCKET_CREATE for SOCKET_OPEN, SOCKET_WRITE, SOCKET_READ, SOCKET_DELETE, and SOCKET_INFO.
Use the Instance Number returned in SOCKET_CREATE and SOCKET_ACCEPT instructions after successful execution.
4
7
Illegal Parameter, Invalid Array Length.
Increase the size of the array used to contain the Socket read and write data.
4
8
Illegal Parameter, Invalid Array Dimension.
Use a one-dimensional array to contain the Socket read and write data.
5
Socket request to cancel operation.
Error occurs when:
  • Ethernet Link is Disabled or Ethernet Cable is Disconnected
  • SOCKET_DELETE operation is performed when SOCKET_OPEN, SOCKET_ACCEPT, SOCKET_READ, or SOCKET_WRITE operation is in progress.
  • Run Mode Change operation is performed when SOCKET_OPEN, SOCKET_ACCEPT, SOCKET_READ, or SOCKET_WRITE operation is in progress.
  • IP Address Collision detected when SOCKET_OPEN, SOCKET_ACCEPT, SOCKET_READ, or SOCKET_WRITE operation is in progress.
Restart the Socket operation based on Socket Type. Refer to the respective State Machine to restart Socket operation.
6
1
Illegal Socket Sequence, Socket Open Operation in progress or Connected.
Error occurs when:
  • SOCKET_OPEN is in progress (BUSY State) and user executes another SOCKET_OPEN instance with same socket instance.
  • SOCKET_OPEN is in progress (BUSY State) and user executes SOCKET_ACCEPT with same socket instance.
Use single SOCKET_OPEN execution for respective Socket Instance. Do not perform SOCKET_ACCEPT operation for same socket instance.
6
2
Illegal Socket Sequence, Socket Accept Operation In progress or Connected.
Error occurs when:
  • SOCKET_ACCEPT is in progress (BUSY State) and user executes another SOCKET_ACCEPT instance with same socket instance.
  • SOCKET_ACCEPT is in progress (BUSY State) and user executes SOCKET_OPEN with same socket instance.
Use single SOCKET_ACCEPT execution for respective Socket Instance. Do not perform SOCKET_OPEN operation for same socket instance.
6
3
Illegal Socket Sequence, Socket configured as TCP Client.
6
4
Illegal Socket Sequence, Socket configured as TCP Server.
6
5
Illegal Socket Sequence, Socket is Connected.
Make sure that the Socket is not already connected with a remote device before executing SOCKET_OPEN or SOCKET_ACCEPT again.
6
6
Illegal Socket Sequence, Socket configured as UDP.
Make sure that UDP Socket Instances are not used with SOCKET_ACCEPT.
6
7
Illegal Socket Sequence, Socket is not connected.
Confirm that the Socket is connected with the target.
7
Socket Instance Timeout.
Configure Timeout values for SOCKET_ACCEPT, SOCKET_OPEN, SOCKET_READ, and SOCKET_WRITE accordingly.
8
The Socket module is not initialized.
Make sure that the Ethernet Link is Enabled or Ethernet Cable of Controller is connected to the Network or resolve Controller IP Address conflict.
9
1
Socket Instruction Fatal Error, Socket Instance Missing.
9
2
Socket Instruction Fatal Error, Invalid Socket Instance.
9
3
Socket Instruction Fatal Error, Invalid Lock Socket Instance.
9
4
Socket Instruction Fatal Error, Invalid Socket Type.
9
5
Socket Instruction Fatal Error, Missing Cancel Handler.
10
1
Socket background processing Error, Address in Use.
10
2
Socket background processing Error, UDP Received a Large Packet and the Packet is larger than Socket Read length.
Make sure the SOCKET_READ Length is equal to greater than the received packet size. Max read size is recommended. Max size for SOCKET_READ is 256.
10
3
Socket background processing Error, TCP Receive Large packet. Packet received is larger than the Socket Read length.
Make sure the SOCKET_READ Length is equal to greater than the received packet size. Because client might send up to the receive window size of 256, 256 is recommended.
10
4
Socket background processing Error, Received RST or Disconnect from Remote Device.
Restart Controller TCP Client or Server as shown in the State Diagram. Verify the Target device that sent RST and make sure that the Target is restarted with correct state.
10
5
Socket background processing Error, UDP Packet received from different device, drop packet. Reserved for future.
10
6
Socket background processing Error, Queue is full.
Error occurs when:
  • SOCKET_READ or SOCKET_WRITE execute four instructions for the same Socket instance in same scan.
  • Perform a SOCKET_READ when four SOCKET_READ instructions are in BUSY state for same Socket instance.
Wait for SOCKET_READ and SOCKET_WRITE queue availability for respective Socket instance.
10
7
Socket background processing Error, SOCKET_READ Parameter change (Length, Offset, Data Array Size, and Data Array Variable).
When the SOCKET_READ state is BUSY, do not modify the input parameters.
11
1
Socket background processing Fatal Error, Missing data pointer.
11
2
Socket background processing Fatal Error, Missing Session Pointer.
11
3
Socket background processing Fatal Error, Invalid TCP or UDP Socket pointer.
11
4
Socket background processing Fatal Error, Invalid Socket Instance Type.
11
5
Socket background processing Fatal Error, Socket Instance Missing.
11
6
Socket background processing Fatal Error,  Invalid Socket Instance.
11
7
Socket background processing Fatal Error, Invalid Socket State.
11
8
Socket background processing Fatal Error, Invalid Socket Type.
11
9
Socket background processing Fatal Error, TCP delete Failure.
11
10
Socket background processing Fatal Error, UDP delete Failure.
128
1
No packet available for disconnect message.
128
2
Not enough room to pre-pend the TCP header.
128
3
Packet append pointer is invalid.
128
7
Invalid Socket pointer.
128
10
Invalid type-of-service, fragment, or time-to-live option.
128
17
Invalid caller for this service.
128
18
Packet is not valid.
128
20
This component has not been enabled.
128
21
This component has already been enabled.
128
22
Listening is not enabled for the specified port.
128
26
Requested suspension was aborted.
128
33
Invalid server IP Address.
128
34
This socket is bound to another port.
128
35
Port is bound to a different socket.
128
36
Socket is not bound.
128
38
The Socket was unbound while suspended waiting for a receive packet.
128
39
Socket was not created.
128
51
No additional listen request structures are available.
128
52
There is already an active listen request for this port.
128
53
Socket is not in a closed state.
128
54
The server socket supplied is not in a listen state.
128
55
No wait time was specified, the connection attempt is in progress.
128
56
Connection failed.
128
57
Request is greater than the receiver's advertised window size in bytes.
128
64
Another thread is suspended. Only one thread is allowed.
128
65
Disconnect failed to complete within the Timeout period.
128
66
Socket is bound.
128
69
No available Port.
128
70
Invalid Port.
128
71
There is already a valid Socket pointer for this port or the specified port does not have an active listen request.
128
72
Same as NX_SUCCESS, except a queued connection request was processed during this call.
128
73
TCP Transmit Queue Exceeded Error.
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal