Member Function Documentation

CDPNetwork::CDPNetwork()

Default constructs an instance of CDPNetwork.

CDPNetwork::~CDPNetwork()

Destroys the instance of CDPNetwork.

[static] void CDPNetwork::CleanupSockets()

Clean up winsock.

[static] int CDPNetwork::GetLastError()

Return the last error (WSAGetLastError for Windows, errno for Linux)

[static] int CDPNetwork::GetLastErrorMessage(char *msgOut, int msgBufferSize, const char *methodName, bool displayMessage)

Generates / gets the last network-related error-message.

Returns: Error code returned by WSAGetLastError()/xn_getlasterror().

Code-example where a CDPMessage containing the last network-related error-message will be printed, if debug-property for m_pParent-component is at least 2:

if (m_sendSocket.SendPacket(m_data, m_packetSize) == UdpSend::ERR)
{
  if ( DebugLevelForComponent(m_pParent, DEBUGLEVEL_EXTENDED))
    CDPNetwork::GetLastErrorMessage(nullptr,0, m_name.ToString().c_str(), true);
}

[static] std::vector<std::string> CDPNetwork::GetMacAddresses(bool skipAddressNull = false)

Get all MAC addresses. Skip null addresses by setting skipAddressNull to true.

See also InitMac().

[static] int CDPNetwork::GetThisComputerHostName(char *hostName)

Get network host name for this computer, copied into hostName. hostName must have pre-allocated memory, at least 32 bytes. Returns 0 if successful, otherwise error code.

[static] IpAddress CDPNetwork::GetThisComputerIpAddress()

Returns 1st network adapter (IP Address) in application.

See also EthernetManager.

[static] bool CDPNetwork::HasNetworkError(int errorVal)

Return true if a network-related error is set. Typically used in conjuction with f.i. TCPException.GetErrorCode() or CDPNetwork::GetLastError().

[static] void CDPNetwork::Init()

Convenience function for executing InitSocketsAndMac().

void CDPNetwork::InitMac()

Initialize MAC addresses, called by CDP during startup. MAC addresses are retrieved and stored. They can be fetched by calling GetMacAddresses().

void CDPNetwork::InitSocketsAndMac()

Initializes winsock and global MAC addresses.

[static] bool CDPNetwork::IsSocketError(SOCKET s, unsigned int timeoutMs = 0)

Returns true if socket has an error within timeoutMs, false if not.

[static] bool CDPNetwork::IsSocketReadReady(SOCKET s, unsigned int timeoutMs)

Returns true if socket is ready to read data within timeoutMs, false if not.

[static] bool CDPNetwork::IsSocketWriteReady(SOCKET s, unsigned int timeoutMs)

Returns true if socket is ready to write data within timeoutMs, false if not.

[static] int CDPNetwork::OSAPIGetSocketPriority()

Get socket priority. Only supported for linux, otherwise 0 is returned.

This function may be used when setting priority for a socket (setsockopt() with SO_PRIORITY) under linux. It will return a value in range [0..6] depending on thread-priority, with value 6 for highest priority.