Indy 9 | Content | Index | Reference

TIdIdent
Hierarchy, Properties, Methods, Events, See Also, Unit: IdIdent
Implements an Ident protocol (RFC 1413) client.

    TIdIdent = class(TIdTCPClient)

Unit
IdIdent
Description
TIdIdent is a TIdTCPClient descendant that implements an Ident protocol as a client, as described in the Internet Standards document:

- RFC 1413 - Identification Protocol

TIdIdent is part of an "Internet Caller ID" where a typical Server queries an Ident Server which is running on that client. This component is typically used to query Ident Servers that run on connecting clients.

TIdIdent.Port
TIdIdent, See Also
POrt number for the connection to an Ident server.

    property Port: integer;

Description
Port is a published Integer property in TIdIdent that represents the port number used for the connection to an Ident server. The default value for Port, as required by the Ident protocol, is assigned in the Create constructor.

Set Host to identify the server IP Address or host name to be used for the connection.

TIdIdent.QueryTimeOut
TIdIdent, See Also
This property is a time out value for the TIdIdent.Query method.

    property QueryTimeOut: Integer;

Description
This property is a time out value for the TIdIdent.Query method. If this timeout is exceeded, the query is abandoned and the EIdIdentQueryTimeOut exception is raised. By default, this value is IdIdentQryTimeout.

TIdIdent.Reply
TIdIdent, See Also
This property is the reply that was sent by an Ident server from a query.

    property Reply: String;

Description
This is the reply that was sent by an Ident server from a query. This reply is parsed by the ReplyCharset, TIdIdent.ReplyOS, TIdIdent.ReplyOther, and TIdIdent.ReplyUserID properties into more usable forms

TIdIdent.ReplyCharset
TIdIdent, See Also
This property returns the charset from the TIdIdent.Reply property.

    property ReplyCharset: String;

Description
This property returns the charset from the TIdIdent.Reply property or the RFC 1413 default value of US-ASCII. The reply is obtained by usint the TIdIdent.Query method.

TIdIdent.ReplyOS
TIdIdent, See Also
This property returns the client's operating system from the TIdIdent.Reply property.

    property ReplyOS: String;

Description
This property returns the client's operating system from the TIdIdent.Reply property. The reply is obtained by usint the TIdIdent.Query method. This value usually is one Id_OS constants which is defined in the IdAssignedNumbers unit.

TIdIdent.ReplyOther
TIdIdent, See Also
This property returns other information from the TIdIdent.Reply property.

    property ReplyOther: String;

Description
This property returns freeform text in the TIdIdent.Reply property. The reply is obtained by using the TIdIdent.Query method. Examples of this are an encrypted audit token, or other non-userid information about a user (such as the real name and phone number of a user from a UNIX passwd file)

TIdIdent.ReplyUserName
TIdIdent, See Also
This property returns the client's User name from the TIdIdent.Reply property.

    property ReplyUserName: String;

Description
This property returns the client's User ID from the TIdIdent.Reply property. The reply is obtained by usint the TIdIdent.Query method. This value may be different for each connection pair passed to the Query method if the computer is a multi-user system.

TIdIdent.Create
TIdIdent
This constructor creates a new TIdIdent object.

    constructor Create(AOwner: TComponent); override;

Description
This constructor creates a new TIdIdent object. It sets the Port property to IdPORT_AUTH and sets the QueryTimeOut property to the IdIdentQryTimeout constant.

TIdIdent.Query
TIdIdent, See Also
This method performs an Ident Query.

    procedure Query(APortOnServer: Word; APortOnClient: Word);

Parameters
APortOnServer: Word
the port that the client computer connected to the server on
APortOnClient: Word
the port that the client is using to make the connection.
Description
This method performs an Ident Query. When performing the query, the server sends a pair of ports. The first port is the port that the client computer connected to the server on. The second port is the port that the client is using to make the connection. The reply is placed in the Reply property and it is also parsed when using the ReplyCharset, ReplyOS, ReplyOther, and ReplyUserID properties. This method will raise an EIdIdentReply class if there is an error. These classes are EIdIdentInvalidPort, EIdIdentNoUser, EIdIdentHiddenUser, EIdIdentUnknownError, and EIdIdentQueryTimeOut.

Created with Doc-O-Matic 2 donated to Project JEDI. Commercial license available from the Doc-O-Matic site.