1.7.5. DLN_DISCONNECT_ALL

DLN_DISCONNECT_ALL Command

Go to response

The DLN_DISCONNECT_ALL command closes connections to all servers at once.

  typedef struct
  {
  DLN_MSG_HEADER header;
  } __PACKED_ATTR DLN_DISCONNECT_ALL_CMD;

Parameters:

header
Defines the DLN message header DLN_MSG_HEADER. The header contains several predefined fields and is used to identify and route messages. When sending the command, a user must fill the following fields:
  • size - The size of the message. Must be equal to the size of the DLN_DISCONNECT_ALL_CMD structure.
  • msgId - Defines the message. For the DLN_DISCONNECT_ALL command it must be set to 0x0012. You can use the DLN_MSG_ID_DISCONNECT_ALL constant.
  • echoCounter - Can be used to link a command to a response. The response will have the same echoCounter value. This field can be any numerical value from 0 to 0xFFFF (65536).
  • handle - A handle to the DLN-series adapter. For the DLN_DISCONNECT_ALL command the HDLN_ALL_DEVICES value must be used.

DLN_DISCONNECT_ALL Response

Go to command

The adapter sends the DLN_DISCONNECT response after the command execution. The result field informs a user if all the connections were successfully closed.

  typedef struct
  {
     DLN_MSG_HEADER header;
     DLN_RESULT result;
  } __PACKED_ATTR DLN_DISCONNECT_ALL_RSP;

Parameters:

header
Defines the DLN message header DLN_MSG_HEADER. The response header contains the following fields:
  • size - The size of the message. It is equal to the size of the DLN_DISCONNECT_ALL_RSP structure.
  • msgId - Defines the message. For the DLN_DISCONNECT_ALL response it is set to 0x0012. The DLN_MSG_ID_DISCONNECT_ALL constant can be used.
  • echoCounter - Links a command to a response. The echoCounter value is copied from the respective command header.
  • handle - A handle to the DLN-series adapter. For the DLN_DISCONNECT_ALL response the HDLN_ALL_DEVICES value is used.
result
Contains the result of the command execution. The following values are available:
  • DLN_RES_SUCCESS - connections to all servers were successfully closed;
  • DLN_RES_NOT_CONNECTED - no connections were present during the command execution.