Class Session
The Session object manages the complete HTTP session including the UI listitem, the ServerChatter, and the ClientChatter.
Inheritance
Namespace: Fiddler
Assembly: FiddlerCore.dll
Syntax
public class Session : ObjectConstructors
Session(HTTPRequestHeaders, Byte[], Boolean)
Initialize a new session from a given request headers and body request builder data. Note: No Session ID is assigned here.
Declaration
public Session(HTTPRequestHeaders oRequestHeaders, byte[] arrRequestBody, bool skipNewSessionEvent = false)Parameters
|
HTTPRequest NB: If you're copying an existing request, use oRequestHeaders.Clone() |
|
System. The bytes of the request's body |
|
System. If True, the 'Session.SessionCreated' event will not be raised for the new session. |
Session(Session)
Copy Constructor. Build
Declaration
public Session(Session toDeepCopy)Parameters
|
Session
toDeepCopy
Session to clone into a new Session instance |
Session(Byte[], Byte[], SessionFlags, Boolean)
Create a Session object from two byte[] representing request and response. This is used when loading a Session Archive Zip.
Declaration
public Session(byte[] arrRequest, byte[] arrResponse, SessionFlags oSF, bool skipNewSessionEvent)Parameters
|
System. The client data bytes |
|
System. The server data bytes |
|
Session SessionFlags for this session |
|
System. Specifies if the Session.SessionCreated event should be raised of not. |
Session(Byte[], Byte[], Boolean)
Create a Session object from two byte[] representing request and response.
Declaration
public Session(byte[] arrRequest, byte[] arrResponse, bool skipNewSessionEvent = false)Parameters
|
System. The client data bytes |
|
System. The server data bytes |
|
System. Specifies if the Session.SessionCreated event should be raised of not. |
Fields
__oTunnel
Used if the Session is bound to a WebSocket or CONNECTTunnel
Declaration
public ITunnel __oTunnelField Value
bBufferResponse
Should response be buffered for tampering.
Declaration
public bool bBufferResponseField Value
|
System.
|
Remarks
ARCH: This should have been a property instead of a field, so we could throw an InvalidStateException if code tries to manipulate this value after the response has begun
m_clientIP
IP Address of the client for this session.
Declaration
[CodeDescription("IP Address of the client for this session.")]
public string m_clientIPField Value
|
System.
|
m_clientPort
Client port attached to Fiddler.
Declaration
[CodeDescription("Client port attached to Fiddler.")]
public int m_clientPortField Value
|
System.
|
m_hostIP
IP Address of the server for this session.
Declaration
[CodeDescription("IP Address of the server for this session.")]
public string m_hostIPField Value
|
System.
|
Metrics
Metrics for timings and sizes stored as this Session progresses
Declaration
public SessionMetrics MetricsField Value
oFlags
Fiddler-internal flags set on the Session.
Declaration
[CodeDescription("Fiddler-internal flags set on the session.")]
public readonly StringDictionary oFlagsField Value
|
System.
|
Remarks
TODO: ARCH: This shouldn't be exposed directly; it should be wrapped by a ReaderWriterLockSlim to prevent exceptions while enumerating the flags for storage, etc
oRequest
Object representing the HTTP Request.
Declaration
[CodeDescription("Object representing the HTTP Request.")]
public ClientChatter oRequestField Value
requestBodyBytes
Contains the bytes of the request body.
Declaration
[CodeDescription("Contains the bytes of the request body.")]
public byte[] requestBodyBytesField Value
|
System.
|
responseBodyBytes
Contains the bytes of the response body.
Declaration
[CodeDescription("Contains the bytes of the response body.")]
public byte[] responseBodyBytesField Value
|
System.
|
ViewItem
Not used in Fiddler Core - holds the list view item object in Fiddler Classic
Declaration
public object ViewItemField Value
|
System.
|
Properties
bHasGRPCMessages
Checks whether this is a GRPCTunnel, and if so, whether it has logged any parsed messages.
Declaration
public bool bHasGRPCMessages { get; }Property Value
|
System.
|
bHasResponse
Returns TRUE if this session's State > ReadingResponse, and oResponse, oResponse.headers, and responseBodyBytes are all non-null. Note that bHasResponse returns FALSE if the session is currently reading, even if a body was copied using the COMETPeek feature
Declaration
[CodeDescription("Returns TRUE if this session state>ReadingResponse and oResponse not null.")]
public bool bHasResponse { get; }Property Value
|
System.
|
bHasWebSocketMessages
Checks whether this is a WebSocket, and if so, whether it has logged any parsed messages.
Declaration
public bool bHasWebSocketMessages { get; }Property Value
|
System.
|
BitFlags
Bitflags of commonly-queried session attributes
Declaration
public SessionFlags BitFlags { get; }Property Value
bypassGateway
Set to true in OnBeforeRequest if this request should bypass the gateway
Declaration
[CodeDescription("Set to true in OnBeforeRequest if this request should bypass the gateway")]
public bool bypassGateway { get; set; }Property Value
|
System.
|
CertificateChainErrors
Stores a list of errors for each Element of the Certificate Chain First element in the list is the Server certificate and each following element follows the certificate chain (the last element should be the CA certificate)
Declaration
public List<List<X509ChainStatus>> CertificateChainErrors { get; set; }Property Value
|
System.
|
clientIP
Returns the Address used by the client to communicate to Fiddler.
Declaration
[CodeDescription("Returns the Address used by the client to communicate to Fiddler.")]
public string clientIP { get; }Property Value
|
System.
|
clientPort
Returns the port used by the client to communicate to Fiddler.
Declaration
[CodeDescription("Returns the port used by the client to communicate to Fiddler.")]
public int clientPort { get; }Property Value
|
System.
|
ConnectedState
Connection state of the current session
Declaration
[CodeDescription("Connection state of the current session.")]
public SessionConnectedState ConnectedState { get; }Property Value
FormattedClientSslVersion
Returns the formatted SSL Version between Fiddler and the client.
Declaration
[CodeDescription("Returns the formatted SSL Version between Fiddler and the client.")]
public string FormattedClientSslVersion { get; }Property Value
|
System.
|
FormattedServerSslVersion
Returns the formatted SSL Version between Fiddler and the server.
Declaration
[CodeDescription("Returns the formatted SSL Version between Fiddler and the server.")]
public string FormattedServerSslVersion { get; }Property Value
|
System.
|
FormattedSslVersion
Returns the formatted SSL Version
Declaration
[CodeDescription("Returns the formatted SSL Version")]
public string FormattedSslVersion { get; }Property Value
|
System.
|
fullUrl
Retrieves the complete URI, including protocol/scheme, in the form http://www.host.com/filepath?query. Or sets the complete URI, adjusting the UriScheme and/or Host.
Declaration
[CodeDescription("Retrieves the complete URI, including protocol/scheme, in the form http://www.host.com/filepath?query.")]
public string fullUrl { get; set; }Property Value
|
System.
|
host
DNS Name of the host server targeted by this request. May include IPv6 literal brackets. NB: a port# may be included.
Declaration
[CodeDescription("Gets/Sets the host to which this request is targeted. MAY include IPv6 literal brackets. MAY include a trailing port#.")]
public string host { get; set; }Property Value
|
System.
|
hostname
DNS Name of the host server (no port) targeted by this request. Will include IPv6-literal brackets for IPv6-literal addresses
Declaration
[CodeDescription("Gets/Sets the hostname to which this request is targeted; does NOT include any port# but will include IPv6-literal brackets for IPv6 literals.")]
public string hostname { get; set; }Property Value
|
System.
|
id
Returns the sequential number of this session. Note, by default numbering is restarted at zero when the session list is cleared.
Declaration
[CodeDescription("Returns the sequential number of this request.")]
public int id { get; }Property Value
|
System.
|
isFTP
When true, this session was conducted using the FTP protocol.
Declaration
[CodeDescription("When true, this session was conducted using the FTP protocol.")]
public bool isFTP { get; }Property Value
|
System.
|
isHTTP2
When true, this session was conducted using the HTTP2 protocol.
Declaration
[CodeDescription("When true, this session was conducted using the HTTP2 protocol.")]
public bool isHTTP2 { get; }Property Value
|
System.
|
isHTTPS
When true, this session was conducted using the HTTPS protocol.
Declaration
[CodeDescription("When true, this session was conducted using the HTTPS protocol.")]
public bool isHTTPS { get; }Property Value
|
System.
|
isTunnel
Returns True if this is a HTTP CONNECT tunnel.
Declaration
public bool isTunnel { get; }Property Value
|
System.
|
IsWebSocketSession
Returns TRUE if the session request or response contains a websocket upgrade header
Declaration
public bool IsWebSocketSession { get; }Property Value
|
System.
|
Item[String]
Simple indexer into the Session's oFlags object; returns null if flag is not present.
Declaration
[CodeDescription("Indexer property into session flags collection. oSession[\"Flagname\"] returns string value (or null if missing!).")]
public string this[string sFlag] { get; set; }Parameters
|
System.
|
Property Value
|
System. Returns the string value if the specified flag is present, or null if it is not. |
Item[String, String]
Indexer property into SESSION flags, REQUEST headers, and RESPONSE headers. e.g. oSession["Request", "Host"] returns string value for the Request host header. If null, returns String.Empty
Declaration
[CodeDescription("Indexer property into SESSION flags, REQUEST headers, and RESPONSE headers. e.g. oSession[\"Request\", \"Host\"] returns string value for the Request host header. If null, returns String.Empty")]
public string this[string sCollection, string sName] { get; }Parameters
|
System. SESSION, REQUEST or RESPONSE |
|
System. The name of the flag or header |
Property Value
|
System. String value or String.Empty |
LocalProcess
Get the Process Info of the application which made this request, or String.Empty if it is not known
Declaration
[CodeDescription("Get the Process Info the application which made this request, or String.Empty if it cannot be determined.")]
public string LocalProcess { get; }Property Value
|
System.
|
LocalProcessID
Get the process ID of the application which made this request, or 0 if it cannot be determined.
Declaration
[CodeDescription("Get the process ID of the application which made this request, or 0 if it cannot be determined.")]
public int LocalProcessID { get; }Property Value
|
System.
|
oResponse
Object representing the HTTP Response.
Declaration
[CodeDescription("Object representing the HTTP Response.")]
public ServerChatter oResponse { get; set; }Property Value
PathAndQuery
Returns the path and query part of the URL. (For a CONNECT request, returns the host:port to be connected.)
Declaration
[CodeDescription("Returns the path and query part of the URL. (For a CONNECT request, returns the host:port to be connected.)")]
public string PathAndQuery { get; set; }Property Value
|
System.
|
port
Returns the server port to which this request is targeted.
Declaration
[CodeDescription("Returns the server port to which this request is targeted.")]
public int port { get; set; }Property Value
|
System.
|
RemoteDeviceId
Extracts the remote device identifier from URL or host name
Declaration
public string RemoteDeviceId { get; }Property Value
|
System.
|
RequestBody
Gets or Sets the HTTP Request body bytes. Setter adjusts Content-Length header, and removes Transfer-Encoding and Content-Encoding headers. Setter DOES NOT CLONE the passed array. Setter will throw if the Request object does not exist for some reason. Use utilSetRequestBody(sStr) to ensure proper character encoding if you need to use a string.
Declaration
[CodeDescription("Gets or Sets the Request body bytes; Setter fixes up headers.")]
public byte[] RequestBody { get; set; }Property Value
|
System.
|
RequestHeaders
Gets Request Headers, or empty headers if headers do not exist
Declaration
[CodeDescription("Gets Request Headers, or empty headers if headers do not exist")]
public HTTPRequestHeaders RequestHeaders { get; }Property Value
RequestHeadersFlat
Gets Request Headers including pseudo headers, or empty headers if headers do not exist
Declaration
[CodeDescription("Gets Request Headers including pseudo headers, or empty headers if headers do not exist")]
public List<HTTPHeaderItem> RequestHeadersFlat { get; }Property Value
|
System.
|
RequestMethod
Gets or Sets the request's Method (e.g. GET, POST, etc).
Declaration
[CodeDescription("Gets or Sets the request's Method (e.g. GET, POST, etc).")]
public string RequestMethod { get; set; }Property Value
|
System.
|
ResponseBody
Gets or Sets the HTTP Response body bytes. Setter adjusts Content-Length header, and removes Transfer-Encoding and Content-Encoding headers. Setter DOES NOT CLONE the passed array. Setter will throw if the Response object has not yet been created. (See utilCreateResponseAndBypassServer) Use utilSetResponseBody(sStr) to ensure proper character encoding if you need to use a string.
Declaration
[CodeDescription("Gets or Sets the Response body bytes; Setter fixes up headers.")]
public byte[] ResponseBody { get; set; }Property Value
|
System.
|
responseCode
Gets or Sets the HTTP Status code of the server's response
Declaration
[CodeDescription("Gets or Sets the HTTP Status code of the server's response")]
public int responseCode { get; set; }Property Value
|
System.
|
ResponseHeaders
Gets Response Headers, or empty headers if headers do not exist
Declaration
[CodeDescription("Gets Response Headers, or empty headers if headers do not exist")]
public HTTPResponseHeaders ResponseHeaders { get; }Property Value
ResponseHeadersFlat
Gets Response Headers including pseudo headers, or empty headers if headers do not exist
Declaration
[CodeDescription("Gets Response Headers including pseudo headers, or empty headers if headers do not exist")]
public List<HTTPHeaderItem> ResponseHeadersFlat { get; }Property Value
|
System.
|
ResponseTrailers
Gets Response Trailers, or empty headers if trailers do not exist
Declaration
[CodeDescription("Gets Response Trailers, or empty headers if trailers do not exist")]
public HTTPResponseHeaders ResponseTrailers { get; }Property Value
state
State of session. Note Side-Effects: If setting to .Aborted, calls FinishUISession. If setting to/from a Tamper state, calls RefreshMyInspectors
Declaration
[CodeDescription("Enumerated state of the current session.")]
public SessionStates state { get; set; }Property Value
SuggestedFilename
Gets a path-less filename suitable for saving the Response entity. Uses Content-Disposition if available.
Declaration
[CodeDescription("Gets a path-less filename suitable for saving the Response entity. Uses Content-Disposition if available.")]
public string SuggestedFilename { get; }Property Value
|
System.
|
Tag
A common use for the Tag property is to store data that is closely associated with the Session. It is NOT marshalled during drag/drop and is NOT serialized to a SAZ file.
Declaration
public object Tag { get; set; }Property Value
|
System.
|
TunnelEgressByteCount
If this session is a Tunnel, returns number of bytes sent from the Client to the Server
Declaration
public long TunnelEgressByteCount { get; }Property Value
|
System.
|
TunnelIngressByteCount
If this session is a Tunnel, returns number of bytes sent from the Server to the Client
Declaration
public long TunnelIngressByteCount { get; }Property Value
|
System.
|
TunnelIsOpen
If this session is a Tunnel, and the tunnel's IsOpen property is TRUE, returns TRUE. Otherwise returns FALSE.
Declaration
public bool TunnelIsOpen { get; }Property Value
|
System.
|
UiSharedId
url
Gets or sets the URL (without protocol) being requested from the server, in the form www.host.com/filepath?query.
Declaration
[CodeDescription("Gets or sets the URL (without protocol) being requested from the server, in the form www.host.com/filepath?query.")]
public string url { get; set; }Property Value
|
System.
|
Methods
AbortAsync()
Closes both client and server pipes and moves state to Aborted; unpauses thread if paused.
Declaration
public Task AbortAsync()Returns
|
System.
|
BuildFromData(Boolean, HTTPRequestHeaders, Byte[], HTTPResponseHeaders, Byte[], SessionFlags)
Factory constructor
Declaration
public static Session BuildFromData(bool bClone, HTTPRequestHeaders headersRequest, byte[] arrRequestBody, HTTPResponseHeaders headersResponse, byte[] arrResponseBody, SessionFlags oSF)Parameters
|
System.
|
|
HTTPRequest
|
|
System.
|
|
HTTPResponse
|
|
System.
|
|
Session
|
Returns
COMETPeek()
Call this function while in the "reading response" state to update the responseBodyBytes array with the partially read response.
Declaration
public bool COMETPeek()Returns
|
System. TRUE if the peek succeeded; FALSE if not in the ReadingResponse state |
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.
Declaration
public string GetRedirectTargetURL()Returns
|
System. null, or Target URL. Note, you may want to call Utilities.TrimAfter(sTarget, '#'); on the response |
GetRedirectTargetURL(String, String)
Gets a redirect-target from a base URI and a Location header
Declaration
public static string GetRedirectTargetURL(string sBase, string sLocation)Parameters
|
System.
|
|
System.
|
Returns
|
System. null, or Target URL. Note, you may want to call Utilities.TrimAfter(sTarget, '#'); |
GetRequestBodyAsBytes()
Return a byte array generated from the request body, decoding it.
Declaration
[CodeDescription("Return a byte array generated from the request body, decoding it.")]
public byte[] GetRequestBodyAsBytes()Returns
|
System. A byte array containing the request body. |
GetRequestBodyAsString()
Return a string generated from the request body, decoding it and converting from a codepage if needed. Throws on errors.
Declaration
[CodeDescription("Return a string generated from the request body, decoding it and converting from a codepage if needed. Possibly expensive due to decompression and will throw on malformed content. Throws on errors.")]
public string GetRequestBodyAsString()Returns
|
System. A string containing the request body. |
GetRequestBodyEncoding()
Find the text encoding of the request WARNING: Will not decompress body to scan for indications of the character set
Declaration
[CodeDescription("Returns the Encoding of the requestBodyBytes")]
public Encoding GetRequestBodyEncoding()Returns
|
System. Returns the Encoding of the requestBodyBytes |
GetResponseBodyAsBytes()
Return a byte array generated from the response body, decoding it.
Declaration
[CodeDescription("Return a byte array generated from the response body, decoding it.")]
public byte[] GetResponseBodyAsBytes()Returns
|
System. A byte array containing the response body. |
GetResponseBodyAsString()
Return a string generated from the response body, decoding it and converting from a codepage if needed. Throws on errors.
Declaration
[CodeDescription("Return a string generated from the response body, decoding it and converting from a codepage if needed. Possibly expensive due to decompression and will throw on malformed content. Throws on errors.")]
public string GetResponseBodyAsString()Returns
|
System. A string containing the response body. |
GetResponseBodyEncoding()
Find the text encoding of the response WARNING: Will not decompress body to scan for indications of the character set
Declaration
[CodeDescription("Returns the Encoding of the responseBodyBytes")]
public Encoding GetResponseBodyEncoding()Returns
|
System. The Encoding of the responseBodyBytes |
HostnameIs(String)
Returns TRUE if the Session's target hostname (no port) matches sTestHost (case-insensitively).
Declaration
[CodeDescription("Returns TRUE if the Session's target hostname (no port) matches sTestHost (case-insensitively).")]
public bool HostnameIs(string sTestHost)Parameters
|
System. The host to which this session's host should be compared. |
Returns
|
System. True if this session is targeted to the specified host. |
HTTPMethodIs(String)
Returns TRUE if the Session's HTTP Method is available and matches the target method.
Declaration
[CodeDescription("Returns TRUE if the Session's HTTP Method is available and matches the target method.")]
public bool HTTPMethodIs(string sTestFor)Parameters
|
System. The target HTTP Method being compared. |
Returns
|
System. true, if the method is specified and matches sTestFor (case-insensitive); otherwise false. |
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.
Declaration
[CodeDescription("Sets the SessionFlags.Ignore bit for this Session, hiding it and ignoring its traffic.")]
public void Ignore()isAnyFlagSet(SessionFlags)
Test the session's BitFlags
Declaration
public bool isAnyFlagSet(SessionFlags FlagsToTest)Parameters
|
Session One or more (OR'd) SessionFlags |
Returns
|
System. TRUE if ANY of specified flag(s) are set |
isFlagSet(SessionFlags)
Test the session's BitFlags
Declaration
public bool isFlagSet(SessionFlags FlagsToTest)Parameters
|
Session One or more (OR'd) SessionFlags |
Returns
|
System. TRUE if ALL specified flag(s) are set |
LoadMetadata(Stream, Boolean)
Read metadata about this session from a stream. NB: Closes the Stream when done.
Declaration
public bool LoadMetadata(Stream strmMetadata, bool skipOriginalIdComment = false)Parameters
|
System. The stream of XML text from which session metadata will be loaded. |
|
System. Specifies if the sessions without comments should ge their original Id as an auto-generated comment of not. |
Returns
|
System. True if the Metadata was successfully loaded; False if any exceptions were trapped. |
LoadRequestBodyFromFile(String)
Replace HTTP request body using the specified file.
Declaration
[CodeDescription("Replace HTTP request headers and body using the specified file.")]
public bool LoadRequestBodyFromFile(string sFilename)Parameters
|
System. The file containing the request |
Returns
|
System. True if the file was successfully loaded as the request body |
LoadResponseFromFileAsync(String)
Replace HTTP response headers and body using the specified file.
Declaration
[CodeDescription("Replace HTTP response headers and body using the specified file.")]
public Task<bool> LoadResponseFromFileAsync(string sFilename)Parameters
|
System. The file containing the response. |
Returns
|
System. True if the file was successfully loaded. |
LoadResponseFromStreamAsync(Stream, String)
Replace HTTP response headers and body using the specified stream.
Declaration
public Task<bool> LoadResponseFromStreamAsync(Stream strmResponse, string sOptionalContentTypeHint)Parameters
|
System. The stream containing the response. |
|
System. Optional content type for the stream data to set in the headers. |
Returns
|
System. True if the Stream was successfully loaded. |
PoisonClientPipe()
Ensures that, after the response is complete, the client socket is closed and not reused. Does NOT (and must not) close the pipe.
Declaration
public void PoisonClientPipe()PoisonServerPipe()
Prevents the server pipe from this session from being pooled for reuse
Declaration
public void PoisonServerPipe()SaveMetadata(String)
Writes this session's metadata to a file.
Declaration
public bool SaveMetadata(string sFilename)Parameters
|
System. The name of the file to which the metadata should be saved in XML format. |
Returns
|
System. True if the file was successfully written. |
SaveResponse(String, Boolean)
Saves the response (headers and body) to a file
Declaration
public void SaveResponse(string sFilename, bool bHeadersOnly)Parameters
|
System. The File to write |
|
System. TRUE if only heaers should be written |
ThreadResume()
This method resumes the Session's thread in response to "Continue" commands from the UI
Declaration
public void ThreadResume()ToHTMLFragment(Boolean)
Returns HTML representing the Session. Call Utilities.StringToCF_HTML on the result of this function before placing it on the clipboard.
Declaration
public string ToHTMLFragment(bool HeadersOnly)Parameters
|
System. TRUE if only the headers should be copied. |
Returns
|
System. A HTML-formatted fragment representing the current session. |
ToString()
Store this session's request and response to a string.
Declaration
public override string ToString()Returns
|
System. A string containing the content of the request and response. |
ToString(Boolean)
Store this session's request and response to a string.
Declaration
public string ToString(bool HeadersOnly)Parameters
|
System. If true, return only the request and response headers |
Returns
|
System. String representing this session |
UNSTABLE_SetBitFlag(SessionFlags, Boolean)
DO NOT USE. TEMPORARY WHILE REFACTORING VISIBILITY OF MEMBERS
Declaration
public void UNSTABLE_SetBitFlag(SessionFlags FlagsToSet, bool b)Parameters
|
Session
|
|
System.
|
uriContains(String)
Returns true if the absolute request URI contains the specified string. Case-insensitive.
Declaration
[CodeDescription("Returns true if request URI contains the specified string. Case-insensitive.")]
public bool uriContains(string sLookfor)Parameters
|
System. Case-insensitive string to find |
Returns
|
System. TRUE if the URI contains the string |
utilAssignResponse(HTTPResponseHeaders, Byte[])
Copy an existing response to this Session, bypassing the server if not already contacted
Declaration
[CodeDescription("Copy an existing response to this Session, bypassing the server if not already contacted")]
public void utilAssignResponse(HTTPResponseHeaders oRH, byte[] arrBody)Parameters
|
HTTPResponse The response headers |
|
System. The response body |
utilAssignResponse(Session)
Copy an existing Session's response to this Session, bypassing the server if not already contacted.
Declaration
[CodeDescription("Copy an existing Session's response to this Session, bypassing the server if not already contacted")]
public void utilAssignResponse(Session oFromSession)Parameters
|
Session
oFromSession
The existing session to copy the response from. |
utilBZIP2Response()
Use BZIP2 to compress the response body. Throws exceptions to caller.
Declaration
[CodeDescription("Use BZIP2 to compress the response body. Throws exceptions to caller.")]
public bool utilBZIP2Response()Returns
|
System. TRUE if compression succeeded |
utilChunkResponse(Int32)
Introduces HTTP Chunked encoding on the response body
Declaration
[CodeDescription("Apply Transfer-Encoding: chunked to the response, if possible.")]
public bool utilChunkResponse(int iSuggestedChunkCount)Parameters
|
System. The number of chunks to try to create |
Returns
|
System. TRUE if the chunking could be performed. |
utilCreateResponseAndBypassServerAsync()
Call inside OnBeforeRequest to create a response object and bypass the server.
Declaration
[CodeDescription("Call inside OnBeforeRequest to create a Response object and bypass the server.")]
public Task utilCreateResponseAndBypassServerAsync()Returns
|
System.
|
utilDecodeRequest()
Removes chunking and HTTP Compression from the Request. Adds or updates Content-Length header.
Declaration
[CodeDescription("Removes chunking and HTTP Compression from the Request. Adds or updates Content-Length header.")]
public bool utilDecodeRequest()Returns
|
System. Returns TRUE if the request was decoded; returns FALSE on failure, or if request didn't have headers that showed encoding. |
utilDecodeRequest(Boolean)
Decode request body in place and delete encoding headers from the request headers.
Declaration
public bool utilDecodeRequest(bool bSilent)Parameters
|
System. True to log/report any exceptions during decoding. |
Returns
|
System. True if request body was decoded, false if nothing to decode or decoding failed. |
utilDecodeResponse()
Removes chunking and HTTP Compression from the Response. Adds or updates Content-Length header.
Declaration
[CodeDescription("Removes chunking and HTTP Compression from the response. Adds or updates Content-Length header.")]
public bool utilDecodeResponse()Returns
|
System. Returns TRUE if the response was decoded; returns FALSE on failure, or if response didn't have headers that showed encoding. |
utilDecodeResponse(Boolean)
Removes chunking and HTTP Compression from the Response. Adds or updates Content-Length header.
Declaration
public bool utilDecodeResponse(bool bSilent)Parameters
|
System. TRUE if error messages should be suppressed. False otherwise. |
Returns
|
System. TRUE if the decoding was successsful. |
utilDeflateResponse()
Use DEFLATE to compress the response body. Throws exceptions to caller.
Declaration
[CodeDescription("Use DEFLATE to compress the response body. Throws exceptions to caller.")]
public bool utilDeflateResponse()Returns
|
System. TRUE if compression succeeded |
utilFindInRequest(String, Boolean)
Find a string in the request body. Return its index, or -1.
Declaration
[CodeDescription("Find a string in the request body. Return its index or -1.")]
public int utilFindInRequest(string sSearchFor, bool bCaseSensitive)Parameters
|
System. Term to search for |
|
System. Require case-sensitive match? |
Returns
|
System. Location of sSearchFor,or -1 |
utilFindInResponse(String, Boolean)
Find a string in the response body. Return its index, or -1.
Declaration
[CodeDescription("Find a string in the response body. Return its index or -1. Note, you should call utilDecodeResponse first!")]
public int utilFindInResponse(string sSearchFor, bool bCaseSensitive)Parameters
|
System. Term to search for |
|
System. Require case-sensitive match? |
Returns
|
System. Location of sSearchFor,or -1 |
utilGZIPRequest()
Use GZIP to compress the request body. Throws exceptions to caller.
Declaration
[CodeDescription("Use GZIP to compress the request body. Throws exceptions to caller.")]
public bool utilGZIPRequest()Returns
|
System. TRUE if compression succeeded |
utilGZIPResponse()
Use GZIP to compress the response body. Throws exceptions to caller.
Declaration
[CodeDescription("Use GZIP to compress the response body. Throws exceptions to caller.")]
public bool utilGZIPResponse()Returns
|
System. TRUE if compression succeeded |
utilPrependToResponseBody(String)
Add a string to the top of the response body, updating Content-Length. (Call utilDecodeResponse first!)
Declaration
[CodeDescription("Prepend a string to the response body. Updates Content-Length header. Note, you should call utilDecodeResponse first!")]
public void utilPrependToResponseBody(string sString)Parameters
|
System. The string to prepend |
utilReplaceInRequest(String, String)
Perform a string replacement on the request body. Adjusts the Content-Length header if needed.
Declaration
[CodeDescription("Perform a case-sensitive string replacement on the request body (not URL!). Updates Content-Length header. Returns TRUE if replacements occur.")]
public bool utilReplaceInRequest(string sSearchFor, string sReplaceWith)Parameters
|
System. The case-sensitive string to search for. |
|
System. The text to replace. |
Returns
|
System. TRUE if one or more replacements occurred. |
utilReplaceInResponse(String, String)
Perform a string replacement on the response body (potentially multiple times). Adjust the Content-Length header if needed.
Declaration
[CodeDescription("Perform a case-sensitive string replacement on the response body. Updates Content-Length header. Note, you should call utilDecodeResponse first! Returns TRUE if replacements occur.")]
public bool utilReplaceInResponse(string sSearchFor, string sReplaceWith)Parameters
|
System. String to find (case-sensitive) |
|
System. String to use to replace |
Returns
|
System. TRUE if replacements occurred |
utilReplaceOnceInResponse(String, String, Boolean)
Perform a one-time string replacement on the response body. Adjust the Content-Length header if needed.
Declaration
[CodeDescription("Perform a single case-sensitive string replacement on the response body. Updates Content-Length header. Note, you should call utilDecodeResponse first! Returns TRUE if replacements occur.")]
public bool utilReplaceOnceInResponse(string sSearchFor, string sReplaceWith, bool bCaseSensitive)Parameters
|
System. String to find (case-sensitive) |
|
System. String to use to replace |
|
System. TRUE for Case-Sensitive |
Returns
|
System. TRUE if a replacement occurred |
utilReplaceRegexInResponse(String, String)
Perform a regex-based string replacement on the response body. Adjusts the Content-Length header if needed.
Declaration
[CodeDescription("Perform a regex-based replacement on the response body. Specify RegEx Options via leading Inline Flags, e.g. (?im) for case-Insensitive Multi-line. Updates Content-Length header. Note, you should call utilDecodeResponse first! Returns TRUE if replacements occur.")]
public bool utilReplaceRegexInResponse(string sSearchForRegEx, string sReplaceWithExpression)Parameters
|
System. The regular expression used to search the body. Specify RegEx Options via leading Inline Flags, e.g. (?im) for case-Insensitive Multi-line. |
|
System. The text or expression used to replace |
Returns
|
System. TRUE if replacements occured |
utilSetRequestBody(String)
Replaces the request body with sString. Sets Content-Length header and removes Transfer-Encoding/Content-Encoding.
Declaration
[CodeDescription("Replaces the request body with sString. Sets Content-Length header & removes Transfer-Encoding/Content-Encoding")]
public void utilSetRequestBody(string sString)Parameters
|
System. The desired request Body as a string |
utilSetResponseBody(String)
Replaces the response body with sString. Sets Content-Length header and removes Transfer-Encoding/Content-Encoding
Declaration
[CodeDescription("Replaces the response body with sString. Sets Content-Length header & removes Transfer-Encoding/Content-Encoding")]
public void utilSetResponseBody(string sString)Parameters
|
System. The desired response Body as a string |
WriteMetadataToStream(Stream)
Write the metadata about this Session to a stream. The Stream is left open!
Declaration
public void WriteMetadataToStream(Stream strmMetadata)Parameters
|
System. The Stream to write to |
WriteRequestToStream(Boolean, Boolean, Boolean, Stream)
Write the session's Request to the specified stream
Declaration
public bool WriteRequestToStream(bool bHeadersOnly, bool bIncludeProtocolAndHostWithPath, bool bEncodeIfBinary, Stream oFS)Parameters
|
System. TRUE if only the headers should be be written |
|
System. TRUE if the Scheme and Host should be written in the Request Line |
|
System. TRUE if binary bodies should be encoded in base64 for text-safe transport (e.g. used by Composer drag/drop) |
|
System. The Stream to which the request should be written |
Returns
|
System. True if the request was written to the stream. False if the request headers do not exist. Throws on other stream errors. |
WriteRequestToStream(Boolean, Boolean, Stream)
Write the session's Request to the specified stream
Declaration
public bool WriteRequestToStream(bool bHeadersOnly, bool bIncludeProtocolAndHostWithPath, Stream oFS)Parameters
|
System. TRUE if only the headers should be be written |
|
System. TRUE if the Scheme and Host should be written in the Request Line |
|
System. The Stream to which the request should be written |
Returns
|
System. True if the request was written to the stream. False if the request headers do not exist. Throws on other stream errors. |
WriteResponseToStream(Stream, Boolean)
Write the session's Response to the specified stream
Declaration
public bool WriteResponseToStream(Stream oFS, bool bHeadersOnly)Parameters
|
System. The stream to which the response should be written |
|
System. TRUE if only the headers should be written |
Returns
|
System. TRUE if the response was written to the stream. False if the response headers do not exist. Throws on other stream errors. |
WriteToStream(Stream, Boolean)
Write the session to the specified stream
Declaration
[CodeDescription("Write the session (or session headers) to the specified stream")]
public bool WriteToStream(Stream oFS, bool bHeadersOnly)Parameters
|
System. The stream to which the session should be written |
|
System. TRUE if only the request and response headers should be written |
Returns
|
System. False on any exceptions; True otherwise |
Events
OnCompleteTransaction
Raised once when the session is finished (state>=Done)
Declaration
public event EventHandler<EventArgs> OnCompleteTransactionEvent Type
|
System.
|
OnContinueTransaction
This event fires if this Session automatically yields a new one, for instance, if Fiddler is configured to automatically follow redirects or perform multi-leg authentication (X-AutoAuth).
Declaration
public event EventHandler<ContinueTransactionEventArgs> OnContinueTransactionEvent Type
|
System.
|
OnStateChanged
This event fires at any time the session's State changes. Use with caution due to the potential for performance impact.
Declaration
public event EventHandler<StateChangeEventArgs> OnStateChangedEvent Type
|
System.
|
SessionCreated
This event fires when new session is created.
Declaration
public static event EventHandler<Session> SessionCreatedEvent Type
|
System.
|