| Session Methods |
The Session type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | Abort |
Closes both client and server pipes and moves state to Aborted; unpauses thread if paused.
|
 | BuildFromData |
Factory constructor
|
| COMETPeek |
Call this function while in the "reading response" state to update the responseBodyBytes array with
the partially read response.
|
| Equals | (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetRedirectTargetURL |
Returns the fully-qualified URL to which this Session's response points, or null.
This method is needed because many servers (illegally) return a relative url in HTTP/3xx Location response headers.
|
| GetRedirectTargetURL(String, String) |
Gets a redirect-target from a base URI and a Location header
|
| GetRequestBodyAsString |
Return a string generated from the request body, decoding it and converting from a codepage if needed. Throws on errors.
|
| GetRequestBodyEncoding |
Find the text encoding of the request
WARNING: Will not decompress body to scan for indications of the character set
|
| GetResponseBodyAsString |
Return a string generated from the response body, decoding it and converting from a codepage if needed. Throws on errors.
|
| GetResponseBodyEncoding |
Find the text encoding of the response
WARNING: Will not decompress body to scan for indications of the character set
|
| GetResponseBodyHash | |
| GetResponseBodyHashAsBase64 | |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| HostnameIs |
Returns TRUE if the Session's target hostname (no port) matches sTestHost (case-insensitively).
|
| HTTPMethodIs |
Returns TRUE if the Session's HTTP Method is available and matches the target method.
|
| Ignore |
Set the SessionFlags.Ignore bit for this Session, also configuring it to stream, drop read data, and bypass event handlers.
For a CONNECT Tunnel, traffic will be blindly shuffled back and forth. Session will be hidden.
|
| isAnyFlagSet |
Test the session's BitFlags
|
| isFlagSet |
Test the session's BitFlags
|
| LoadMetadata |
Read metadata about this session from a stream. NB: Closes the Stream when done.
|
| LoadRequestBodyFromFile |
Replace HTTP request body using the specified file.
|
| LoadResponseFromFile |
Replace HTTP response headers and body using the specified file.
|
| LoadResponseFromStream |
Replace HTTP response headers and body using the specified stream.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| PoisonClientPipe |
Ensures that, after the response is complete, the client socket is closed and not reused.
Does NOT (and must not) close the pipe.
|
| PoisonServerPipe |
Prevents the server pipe from this session from being pooled for reuse
|
| SaveMetadata |
Writes this session's metadata to a file.
|
| SaveRequest(String, Boolean) |
Save the request to a file.
The headers' Request Line will not contain the scheme or host, which is probably not what you want.
|
| SaveRequest(String, Boolean, Boolean) |
Save the request to a file. Throws if file cannot be written.
|
| SaveRequestBody |
Save the request body to a file. You likely want to call utilDecodeRequest first.
|
| SaveResponse |
Saves the response (headers and body) to a file
|
| SaveResponseBody |
Save HTTP response body to Fiddler Captures folder. You likely want to call utilDecodeResponse first.
|
| SaveResponseBody(String) |
Save HTTP response body to specified location. You likely want to call utilDecodeResponse first.
|
| SaveSession |
Save the request and response to a single file.
|
| ThreadResume |
This method resumes the Session's thread in response to "Continue" commands from the UI
|
| ToHTMLFragment |
Returns HTML representing the Session. Call Utilities.StringToCF_HTML on the result of this function before placing it on the clipboard.
|
| ToString |
Store this session's request and response to a string.
(Overrides ObjectToString.) |
| ToString(Boolean) |
Store this session's request and response to a string.
|
| UNSTABLE_SetBitFlag |
DO NOT USE. TEMPORARY WHILE REFACTORING VISIBILITY OF MEMBERS
|
| uriContains |
Returns true if the absolute request URI contains the specified string. Case-insensitive.
|
| utilAssignResponse(Session) | |
| utilAssignResponse(HTTPResponseHeaders, Byte) | |
| utilBZIP2Response |
Use BZIP2 to compress the response body. Throws exceptions to caller.
|
| utilChunkResponse |
Introduces HTTP Chunked encoding on the response body
|
| utilCreateResponseAndBypassServer |
Call inside OnBeforeRequest to create a response object and bypass the server.
|
| utilDecodeRequest |
Removes chunking and HTTP Compression from the Request. Adds or updates Content-Length header.
|
| utilDecodeRequest(Boolean) | |
| utilDecodeResponse |
Removes chunking and HTTP Compression from the Response. Adds or updates Content-Length header.
|
| utilDecodeResponse(Boolean) |
Removes chunking and HTTP Compression from the Response. Adds or updates Content-Length header.
|
| utilDeflateResponse |
Use DEFLATE to compress the response body. Throws exceptions to caller.
|
| utilFindInRequest |
Find a string in the request body. Return its index, or -1.
|
| utilFindInResponse |
Find a string in the response body. Return its index, or -1.
|
| utilGZIPRequest |
Use GZIP to compress the request body. Throws exceptions to caller.
|
| utilGZIPResponse |
Use GZIP to compress the response body. Throws exceptions to caller.
|
| utilPrependToResponseBody |
Add a string to the top of the response body, updating Content-Length. (Call utilDecodeResponse first!)
|
| utilReplaceInRequest |
Perform a string replacement on the request body. Adjusts the Content-Length header if needed.
|
| utilReplaceInResponse |
Perform a string replacement on the response body (potentially multiple times). Adjust the Content-Length header if needed.
|
| utilReplaceOnceInResponse |
Perform a one-time string replacement on the response body. Adjust the Content-Length header if needed.
|
| utilReplaceRegexInResponse |
Perform a regex-based string replacement on the response body. Adjusts the Content-Length header if needed.
|
| utilSetRequestBody |
Replaces the request body with sString. Sets Content-Length header and removes Transfer-Encoding/Content-Encoding.
|
| utilSetResponseBody |
Replaces the response body with sString. Sets Content-Length header and removes Transfer-Encoding/Content-Encoding
|
| WriteMetadataToStream |
Write the metadata about this Session to a stream. The Stream is left open!
|
| WriteRequestToStream(Boolean, Boolean, Stream) |
Write the session's Request to the specified stream
|
| WriteRequestToStream(Boolean, Boolean, Boolean, Stream) |
Write the session's Request to the specified stream
|
| WriteResponseToStream |
Write the session's Response to the specified stream
|
| WriteToStream |
Write the session to the specified stream
|
See Also