Hypertext Transfer Protocol


Class aprHTTP

 

Description

The Hypertext Transfer Protocol (HTTP) library is used to communicate with web servers. Primarily it is used to transfer web pages, documents, images, etc. from a web server (GET) and send data (POST) to the server for processing.

 

For Secure Edition information, see SLL Certificates.

 

VARs

 

cErr

Holds the Last Error description

 

Debug

Logical for Enabling / Disabling additional Debug messages.

 

DebugTrace

Logical. Whether or not to include the Callstack in the Debug messages.

 

HTTPVersion

HTTP version to use in talking with the Server.

 

LastURL

Holds the last successful URL connection.

 

nErr

Holds the Last Error number

 

Referer

Get / Set the HTTP Data for the Referer.

 

Session

Holds the initial Session Handle.

Used as the default for subsequent Method Calls.

 

UserAgent

Get / Set the HTTP Data for the User-Agent.

 

Methods

 

New()

Initializes an Instance of the aprHTTP Class

 

Destroy()

Releases resources for the Instance of the aprHTTP Class

 

 

 

 

Authenticate()

Specify authentication information for restricted resources

 

Cancel()

Cancel the current blocking operation

 

CloseFile()

Close the file opened on the remote server

 

Command()

Send a Command to the remote server

 

Connect()

Connect to the specified server

 

CreateFile()

Create or replace a resource on the server

 

DeleteFile()

Remove a resource from the server

 

DisConnect()

Disconnect from the current server

 

Flush()

Flush all data from the receive buffer

 

GetBytesCopied()

Return the number of bytes downloaded from the server

 

GetEncodingType()

Get the content-encoding value

 

GetFile()

Copy a file from the server to the local system

 

GetOption()

Return the enabled/disabled state of a specified option

 

GetRequestHeader()

Return the value of the specified request header field

 

GetResponseHeader()

Return the value of the specified response header field

 

GetResultCode()

Return the result code from the previous command

 

GetResultString()

Return the result string from the previous command

 

GetSocket()

Return the current session socket

 

IsBlocking()

Determine if the client is blocked, waiting for information

 

IsConnected()

Determine if the client is connected to the server

 

IsReadable()

Determine if data can be read from the server

 

IsWritable()

Determine if data can be written to the server

 

OpenFile()

Open a file on the server for reading

 

ProxyConnect()

Establish a connection with the specified proxy server

 

PutFile()

Copy a file from the local system to the remote server

 

Read()

Read data returned by the remote server

 

SendRequest()

Send a request to the remote server

 

SetEncodingType()

Set the content-encoding value

 

SetLastError()

Set the current error code

 

SetOption()

Enable/disable specified option

 

SetRequestHeader()

Set the value of a request header field

 

SubmitQuery()

Submit a query string to the server for processing

 

TimeOut()

Return the number of seconds until an operation times out

 

Trace()

Enable/Disable/Configure logging of socket-level calls to the trace log

 

Write ()

Writes data to the remote server

aSocks Secure Edition

 

See SSL Certificates