PORT_INFO NSSOAP Classes

The PORT_INFO class contains information about a fax port on the fax server.

class PORT_INFO {
  string          port_name; // Port name
  PORT_CONFIG     port_config; // How the port is configured
  PORT_STATUS     port_status; // Port status
  string          message_handle; // Message associated with active port
  MESSAGE_TYPE    message_type; // Type of message
  CONNECTION_INFO connection_info; // Real-time details about the connection
}


Members:
port_name The name of the fax port.
 
port_config Specifies the general configuration of the fax port.  Will be set to one or more values from the PORT_CONFIG enumeration.
 
enum PORT_CONFIG {
  Inbound = 1, // Configured for inbound
  Outbound = 2, // Configured for outbound
  Disabled = 4 // Configured to not be used
}

Use a bitwise comparison to test each value like so:

    if ((pi.port_config & PORT_CONFIG.Inbound) != 0)
      {
        // configured for inbound
      }


port_status Specifies the current port status of the fax port.  Will be set to one or more values from the PORT_STATUS enumeration.
 
enum PORT_STATUS {
  Normal = 0,  
  DownlineBusy = 1, // A downline device is using the line 
  DatamodemBusy = 2, // The ports datamodem is busy.
  Defective = 4, // The ports firmware is not responding
  ReloadingFirmware = 8, // The ports firmware is currently being reloaded 
  Resetting = 16 // The ports firmware is currently resetting
}

Use a bitwise comparison to test each value like so:

    if ((pi.port_status & PORT_STATUS.Defective) != 0)
      {
        // the port is defective
      }


message_handle The handle of the sending or receiving message that is associated with this fax port.  If this port is idle, this field wll be null.
 
message_type Specifies whether there is a message associated with the port, and if so, whether it is a Send or Receive message.  Will be a member of the MESSAGE_TYPE enumeration.
 
enum MESSAGE_TYPE {
  None, // No message is available (connection_info will be null)
  Send, // A sending message
  Receive // A receiving message
}

connection_info Contains real-time connection information, in the form of a CONNECTION_INFO object, for the message being sent or received on the fax port, or null if the port is idle.

Remarks:
A PORT_INFO object is obtained by calling get_ports.

See Also:
get_ports