Property | Type | Description | |
---|---|---|---|
$_authObj | Horde_Imsp_Auth_Base | ||
$_stream | resource | Stream handle |
Method | Description | |
---|---|---|
__construct ( array $params ) | Constructor function. | |
authenticate ( boolean $login = true ) : boolean | Attempts to login to IMSP server. | |
capability ( ) : string | Returns the raw capability response from the server. | |
getServerResponseChunks ( ) : array |
Retrieves CRLF terminated response from server and splits it into
an array delimited by a |
|
logout ( ) | Logs out of the server and closes the IMSP stream | |
receive ( ) : mixed | Receives a single CRLF terminated server response string | |
receiveStringLiteral ( integer $length ) : string | Receives fixed number of bytes from IMSP socket. Used when server returns a string literal. | |
send ( string $commandText, boolean $includeTag = true, boolean $sendCRLF = true, boolean $continuation = false ) | Attempts to send a command to the server. |
Method | Description | |
---|---|---|
_imspOpen ( ) | Attempts to open an IMSP socket with the server. |
authObjOptional parameters:The object to handle the authentication
serverThe IMSP host port The port the IMSP server listens on logger The logger.
public __construct ( array $params ) | ||
$params | array | Hash containing server parameters. |
protected _imspOpen ( ) |
public authenticate ( boolean $login = true ) : boolean | ||
$login | boolean | Should we remain logged in after auth? |
return | boolean |
public capability ( ) : string | ||
return | string | The raw capability response. |
public getServerResponseChunks ( ) : array | ||
return | array | The exploded string |
public receiveStringLiteral ( integer $length ) : string | ||
$length | integer | Number of bytes to read from socket. |
return | string | Text of string literal. |
public send ( string $commandText, boolean $includeTag = true, boolean $sendCRLF = true, boolean $continuation = false ) | ||
$commandText | string | Text to send to the server. |
$includeTag | boolean | Determines if command tag is prepended. |
$sendCRLF | boolean | Determines if CRLF is appended. |
$continuation | boolean | Expect a command continuation response. |