LDAP4D Directory - Communication Methods

• LDAPD_TCP_Listen
• LDAPD_TCP_Receive
• LDAPD_TCP_Status
• LDAPD_Message_Send
• LDAPD_CloseConnection

About this section...

This section describes the methods used to do the actual communication with an LDAP server. The underlying mechanism for this is via TCP/IP plugins - Network ToolKit by Pluggers Software is the only one currently supported.

LDAPD_TCP_Listen

Syntax:

result := LDAPD_TCP_Listen ( portToListenOn:LI )

Description:

Wrapper for TCP Listen command.

Warning:

Note:

 returns value of TCP Listen

Params:

In/Out	Parameter	Type		Example or note
->	port	Longint	Port on which to listen
<-	sessionID	Longint	sessionID

Example:

$sessionID := LDAPD_TCP_Listen(LDAPD_Port(1389))

LDAPD_TCP_Receive

Syntax:

result:=LDAPD_TCP_Receive ( streamRef:T; messageID;LI; messageText:T )

Description:

Wrapper for TCP Receive command

Warning:

Note:

Params:

Example:

$iErr:=LDAPD_TCP_Receive($iSessionID;->someBlob)

LDAPD_TCP_Status

Syntax:

result:=LDAPD_TCP_Status ( streamRef:T )

Description:

Receive an expected response from an LDAP server on previously opened stream.

Warning:

Note:

This method sets a number of variables if successful. See Response Methods for detail.

Params:

Example:

$iErr:=LDAPD_TCP_Status($iStreamRef)

LDAPD_Message_Send

Syntax:

result:=LDAPD_Message_Send ( streamRef:T; messageID;LI; messageText:T )

Description:

Send a message to LDAP server on previously opened stream.

Warning:

I

Note:

 Primarily, LDAP4D Directory will only need to send BindResponse, SearchResEntry, and SearchResultDone.
See RFC 2251 4.1.1. Message Envelope.
 

Params:

Example:

$iErr:=LDAPD_TCP_Message_Send($iSessionID;$iMessageID;$oSomeMessage)

LDAPD_CloseConnection

Syntax:

LDAP_CloseConnection ( sessionID:LI )

Description:

Close a connection with the given connection ID.

Warning:

Note:

 None.

Params:

Example:

LDAPD_CloseConnection($iSessionID)