HttpServer.ReceiveRequest Method (Int32, String)

Receive the request that was sent by the client to the server.

Parameters

clientId

An integer that identifies the client session.

requestData

A string passed by reference that will contain any data submitted by the client as part of the request.

Return Value

A boolean value which specifies if the client request was received. A return value of true specifies that the operation was successful. If an error occurs, the method returns false and the application should check the value of the LastError property to determine the cause of the failure

Remarks

The ReceiveRequest method is called within an OnCommand event handler to process the command issued by the client and return information about the request to the server application. It is only necessary for the application to call this method if it wants to implement its own custom handling for a command.

It is recommended that you only use this method to process custom commands and not standard commands such as GET and POST. This ensures that the appropriate security checks are performed and the response conforms to the protocol standard. After the request data has been processed, the application should use the SendResponse or SendError method to send a response back to the client indicating success or failure.

This version of the method uses the active client session and should only be called from within a server event handler. To specify a client session outside of an event handler, use the version of this method that accepts a client ID parameter.

This method may only be called once per command issued by the client.

See Also

HttpServer Class | SocketTools Namespace | HttpServer.ReceiveRequest Overload List