Options for defining an HTTP object's state.
| Name | Description |
|---|---|
| HGS::AUTHENTICATED | Following successful authentication, this state value will be set. |
| HGS::AUTHENTICATING | If authentication is requested from the server, the HTTP object will enter this state. |
| HGS::COMPLETED | This state indicates that the HTTP request was completed in a normal manner. |
| HGS::READING_CONTENT | The client will remain in this state when the server is sending data to the client. |
| HGS::READING_HEADER | The default state - this value will be indicated when no data is being written to the server and the client is waiting for a complete header from the server. |
| HGS::SENDING_CONTENT | During the uploading of data to the server (e.g. POST), the HTTP object will remain in this state. |
| HGS::SEND_COMPLETE | On successful completion of the send phase, the state changes to SEND_COMPLETE. Successful completion requires either that the number of bytes indicated in ContentLength have been sent, or ERR::Terminate has been returned by the callback functions. |
| HGS::TERMINATED | If an HTTP command fails to complete normally - for instance if the connection is broken before completion - then the state is set to TERMINATED. |
Output mode.
| Name | Description |
|---|---|
| HOM::DATA_FEED | Use the DataFeed() action to send data to the targeted object. |
| HOM::READ_WRITE | Use the Write() action to send data to the targeted object. |
HTTP flags
| Name | Description |
|---|---|
| HTF::DEBUG_SOCKET | Log all HTTP headers and data that goes out through the socket. This should only be used when sending plain-text data. |
| HTF::DISABLE_SERVER_VERIFY | Disable SSL server certificate verification (use with caution). |
| HTF::MESSAGE | When activating child objects, send delayed messages to postpone execution rather than making direct calls. |
| HTF::MOVED | Read-only. Indicates that the HTTP source was moved (HTS::MOVED_PERMANENTLY). |
| HTF::NO_AUTO_REDIRECT | Do not automatically follow 301 responses. |
| HTF::NO_DIALOG | Turn off the username/password dialog. |
| HTF::NO_HEAD | Do not send a HEAD prior to executing a PUT or POST (removes the authentication check). |
| HTF::RAW | Forcibly turns off chunk detection and chunk handling on incoming data. Also turns off automatic chunk encoding for outgoing data. |
| HTF::RECV_BUFFER | Enables buffering of all received HTTP content into a local buffer. The buffer information can be read at any time during and after the transaction through the RecvBuffer field. Note that this option should only be used for limited data transfers to avoid excessive memory usage. |
| HTF::REDIRECTED | Read-only. Indicates that the HTTP request was redirected (HTS::TEMP_REDIRECT). |
| HTF::RESUME | Enables resuming when downloading content. Only applies when a file is being targeted and the file already exists. |
| HTF::SSL | Force SSL connectivity, irrespective of the HTTP port. Note that this flag is automatically set (and remains set for all future transfers) if the Port field is set to 443. |
The HTTP Method to use when the object is activated.
| Name | Description |
|---|---|
| HTM::BCOPY | WebDAV instruction. |
| HTM::BDELETE | WebDAV instruction. |
| HTM::BMOVE | WebDAV instruction. |
| HTM::BPROPFIND | WebDAV instruction. |
| HTM::BPROPPATCH | WebDAV instruction. |
| HTM::COPY | WebDAV instruction. |
| HTM::DELETE | Deletes a file from the HTTP server, location indicated by the Path field. |
| HTM::GET | Retrieves files from the HTTP server. The Path field will indicate which file to retrieve. |
| HTM::HEAD | A HEAD request is equivalent to a GET without the content. |
| HTM::LOCK | WebDAV instruction. |
| HTM::MKCOL | WebDAV instruction. |
| HTM::MOVE | WebDAV instruction. |
| HTM::NOTIFY | WebDAV instruction. |
| HTM::OPTIONS | Request permitted communication options for a given URL or server. |
| HTM::PATCH | Applies partial modifications to a resource. |
| HTM::POLL | WebDAV instruction. |
| HTM::POST | Sends information to the HTTP server. |
| HTM::PROPFIND | WebDAV instruction. |
| HTM::PROPPATCH | WebDAV instruction. |
| HTM::PUT | Uploads a file to the HTTP server. The data will be read from the InputFile or InputObject references. |
| HTM::SEARCH | WebDAV instruction. |
| HTM::SUBSCRIBE | WebDAV instruction. |
| HTM::TRACE | Perform a message loop-back test along the path to the target resource. |
| HTM::UNLOCK | WebDAV instruction. |
| HTM::UNSUBSCRIBE | WebDAV instruction. |
HTTP status codes
| Name | Description |
|---|---|
| HTS::ACCEPTED | |
| HTS::BAD_GATEWAY | |
| HTS::BAD_REQUEST | |
| HTS::CONFLICT | |
| HTS::CONTINUE | |
| HTS::CREATED | |
| HTS::ENTITY_TOO_LARGE | |
| HTS::EXPECTATION_FAILED | |
| HTS::FORBIDDEN | |
| HTS::FOUND | |
| HTS::GATEWAY_TIMEOUT | |
| HTS::GONE | |
| HTS::LENGTH_REQUIRED | |
| HTS::METHOD_NOT_ALLOWED | |
| HTS::MOVED_PERMANENTLY | |
| HTS::MULTIPLE_CHOICES | |
| HTS::NOT_ACCEPTABLE | |
| HTS::NOT_FOUND | |
| HTS::NOT_IMPLEMENTED | |
| HTS::NOT_MODIFIED | |
| HTS::NO_CONTENT | |
| HTS::OKAY | |
| HTS::OUT_OF_RANGE | |
| HTS::PARTIAL_CONTENT | |
| HTS::PAYMENT_REQUIRED | |
| HTS::PRECONDITION_FAILED | |
| HTS::PROXY_AUTHENTICATION | |
| HTS::REQUEST_TIMEOUT | |
| HTS::RESET_CONTENT | |
| HTS::SEE_OTHER | |
| HTS::SERVER_ERROR | |
| HTS::SERVICE_UNAVAILABLE | |
| HTS::SWITCH_PROTOCOLS | |
| HTS::TEMP_REDIRECT | |
| HTS::UNAUTHORISED | |
| HTS::UNSUPPORTED_MEDIA | |
| HTS::UNVERIFIED_CONTENT | |
| HTS::URI_TOO_LONG | |
| HTS::USE_PROXY | |
| HTS::VERSION_UNSUPPORTED |