Defines

Error and Return Codes

This module documents all the error and return codes reported by the various library functions. More...

Defines

#define CANETH_SUCCESS   0
 Operation was successful.
#define CANETH_ILLEGAL_ARGUMENT_ERROR   (-1)
 Illegal argument error.
#define CANETH_NO_MSG   (-2)
 No messages.
#define CANETH_INVALID_HOST   (-3)
 Invalid IP address or hostname.
#define CANETH_MAX_OPEN   (-4)
 Maximum number of open connections exceeded.
#define CANETH_SOCKET_LIB_ERROR   (-5)
 Socket library error.
#define CANETH_PORT_ALREADY_BOUND   (-6)
 UDP port already bound.
#define CANETH_SOCKET_FAILED   (-7)
 Creation of socket failed.
#define CANETH_CREATE_THREAD_FAILED   (-8)
 Creation of background thread failed.

Detailed Description

This module documents all the error and return codes reported by the various library functions.


Define Documentation

#define CANETH_SUCCESS   0

Operation was successful.

This return codes indicates no error.

#define CANETH_ILLEGAL_ARGUMENT_ERROR   (-1)

Illegal argument error.

A parameter passed to the function returning this error code is invalid or out of range.

#define CANETH_NO_MSG   (-2)

No messages.

The receive buffer does not contain any messages.

#define CANETH_INVALID_HOST   (-3)

Invalid IP address or hostname.

The IP address or hostname provided is invalid or cannot be reached.

#define CANETH_MAX_OPEN   (-4)

Maximum number of open connections exceeded.

Maximum number of usable CAN connections were exceeded.

#define CANETH_SOCKET_LIB_ERROR   (-5)

Socket library error.

The TCP/IP socket library (e.g. WINSOCK) could not be loaded or the DLL is missing or not installed.

#define CANETH_PORT_ALREADY_BOUND   (-6)

UDP port already bound.

Indicates that the specified UDP port cannot be bound. The port might already be taken by another application or hasn't been released yet by the TCP/IP stack for re-use.

#define CANETH_SOCKET_FAILED   (-7)

Creation of socket failed.

The creation of a UDP socket failed.

#define CANETH_CREATE_THREAD_FAILED   (-8)

Creation of background thread failed.

The system could not create the background receive thread.


CAN-ETH C Library
Draft Version