Whois Class
Properties Methods Events Configuration Settings Errors
The Whois component allows you to query a WHOIS Server for Domain registration information.
Class Name
IPWorks_Whois
Procedural Interface
ipworks_whois_open(); ipworks_whois_close($res); ipworks_whois_register_callback($res, $id, $function); ipworks_whois_get_last_error($res); ipworks_whois_get_last_error_code($res); ipworks_whois_set($res, $id, $index, $value); ipworks_whois_get($res, $id, $index); ipworks_whois_do_config($res, $configurationstring); ipworks_whois_do_doevents($res); ipworks_whois_do_interrupt($res); ipworks_whois_do_query($res, $domain);
Remarks
This component implements the WHOIS protocol defined in RFC 954.
To use the class, simply call the Query method and set the Domain parameter to the domain you wish to retrieve information for. This will trigger a WHOIS search on the domain. Upon completion of the search, the DomainInfo property contains the information about the domain.
If the Server property is empty, then a search is performed automatically at "whois.internic.net" for the appropriate WHOIS server for the domain, and the Server property is set to the server found.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
DefaultServer | The default server from which to retrieve registrar information. |
DomainInfo | The information that is returned by the Server . |
FirewallAutoDetect | This property tells the component whether or not to automatically detect and use firewall system settings, if available. |
FirewallType | This property determines the type of firewall to connect through. |
FirewallHost | This property contains the name or IP address of firewall (optional). |
FirewallPassword | This property contains a password if authentication is to be used when connecting through the firewall. |
FirewallPort | This property contains the TCP port for the firewall Host . |
FirewallUser | This property contains a user name if authentication is to be used connecting through a firewall. |
Idle | The current status of the component. |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
Server | The server to request domain information from. |
ServerPort | The server port for Whois (default 43). |
Timeout | A timeout for the component. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
Config | Sets or retrieves a configuration setting . |
DoEvents | Processes events from the internal message queue. |
Interrupt | Interrupt the current method. |
Query | Get information about a domain. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
Connected | Fired immediately after a connection completes (or fails). |
ConnectionStatus | Fired to indicate changes in connection state. |
Disconnected | Fired when a connection is closed. |
Error | Information about errors during data delivery. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The TCP port in the local host where the component binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
RecordLength | The length of received data records. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
UseIPv6 | Whether to use IPv6. |
TcpNoDelay | Whether or not to delay when sending packets. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
CodePage | The system code page used for Unicode to Multibyte translations. |