438 lines
46 KiB
XML
438 lines
46 KiB
XML
|
<?xml version="1.0"?>
|
||
|
|
<doc>
|
||
|
|
<assembly>
|
||
|
|
<name>Microsoft.VisualStudio.RemoteControl</name>
|
||
|
|
</assembly>
|
||
|
|
<members>
|
||
|
|
<member name="T:Microsoft.VisualStudio.RemoteControl.FileReader">
|
||
|
|
<summary>
|
||
|
|
An instance of this class represents reading from a particular file from disk.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="T:Microsoft.VisualStudio.RemoteControl.GetFileResult">
|
||
|
|
<summary>
|
||
|
|
Holds information about the settings file, downloaded from the server or from the
|
||
|
|
local IE cache. Returned by calls to methods in this class.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="P:Microsoft.VisualStudio.RemoteControl.GetFileResult.Code">
|
||
|
|
<summary>
|
||
|
|
Gets or sets a status code of the response from server
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="P:Microsoft.VisualStudio.RemoteControl.GetFileResult.RespStream">
|
||
|
|
<summary>
|
||
|
|
Gets or sets a stream to read the content of the settings file.
|
||
|
|
! May be null if <seealso cref="P:Microsoft.VisualStudio.RemoteControl.GetFileResult.Code" /> is not OK.
|
||
|
|
! Callers must call Dispose on this object if it is not null.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="P:Microsoft.VisualStudio.RemoteControl.GetFileResult.IsFromCache">
|
||
|
|
<summary>
|
||
|
|
Gets or sets a value indicating whether this information is obtained from IE cache.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="P:Microsoft.VisualStudio.RemoteControl.GetFileResult.AgeSeconds">
|
||
|
|
<summary>
|
||
|
|
Gets or sets the Age of the file in the cache if
|
||
|
|
<seealso cref="P:Microsoft.VisualStudio.RemoteControl.GetFileResult.IsFromCache" /> is true, returns . Otherwise null.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="P:Microsoft.VisualStudio.RemoteControl.GetFileResult.ErrorMessage">
|
||
|
|
<summary>
|
||
|
|
Gets or sets the error message if <seealso cref="P:Microsoft.VisualStudio.RemoteControl.GetFileResult.Code" /> is not
|
||
|
|
OK or NotFound.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="P:Microsoft.VisualStudio.RemoteControl.GetFileResult.IsSuccessStatusCode">
|
||
|
|
<summary>
|
||
|
|
Gets a value indicating whether <seealso cref="P:Microsoft.VisualStudio.RemoteControl.GetFileResult.Code" /> is OK or
|
||
|
|
NotFound.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="T:Microsoft.VisualStudio.RemoteControl.IFileReader">
|
||
|
|
<summary>
|
||
|
|
An instance of this class represents reading from a particular file from disk.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="T:Microsoft.VisualStudio.RemoteControl.BehaviorOnStale">
|
||
|
|
<summary>
|
||
|
|
Specifies the behavior of the IRemoteControlClient.ReadFile method
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="F:Microsoft.VisualStudio.RemoteControl.BehaviorOnStale.ReturnStale">
|
||
|
|
<summary>
|
||
|
|
Return the settings file in the local cache irrespective of staleness.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="F:Microsoft.VisualStudio.RemoteControl.BehaviorOnStale.ReturnNull">
|
||
|
|
<summary>
|
||
|
|
Return the settings file in the local cache if it is not stale. Otherwise return Null.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="F:Microsoft.VisualStudio.RemoteControl.BehaviorOnStale.ForceDownload">
|
||
|
|
<summary>
|
||
|
|
Revalidate or download the file from the server and return it. WARNING:
|
||
|
|
* each server request is billed and costs add up from millions of clients.
|
||
|
|
* the only acceptable use of ForceDownload is very infrequently and if you absolutely cannot function
|
||
|
|
without the latest settings
|
||
|
|
* keep in mind that even once-per-process-lifetime may be too much if you process starts and stops very
|
||
|
|
frequently.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="T:Microsoft.VisualStudio.RemoteControl.IRemoteControlClient">
|
||
|
|
<summary>
|
||
|
|
Interface for the client for the Remote Control Service.
|
||
|
|
This client polls the service for a single settings file and keeps it up-to-date in the local IE cache (which
|
||
|
|
is per-user). Developers may call the <see cref="M:Microsoft.VisualStudio.RemoteControl.IRemoteControlClient.ReadFile(Microsoft.VisualStudio.RemoteControl.BehaviorOnStale)" /> or
|
||
|
|
<see cref="M:Microsoft.VisualStudio.RemoteControl.IRemoteControlClient.ReadFileAsync(Microsoft.VisualStudio.RemoteControl.BehaviorOnStale)" /> to read settings file.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="P:Microsoft.VisualStudio.RemoteControl.IRemoteControlClient.FullUrl">
|
||
|
|
<summary>
|
||
|
|
Gets a full URL used to download to the file. Read-Only.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="P:Microsoft.VisualStudio.RemoteControl.IRemoteControlClient.PollingIntervalMins">
|
||
|
|
<summary>
|
||
|
|
Gets a polling Interval to check the file on the server. Read-Only.
|
||
|
|
This setting also determines when a file in the local IE cache is
|
||
|
|
considered stale.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="M:Microsoft.VisualStudio.RemoteControl.IRemoteControlClient.ReadFile(Microsoft.VisualStudio.RemoteControl.BehaviorOnStale)">
|
||
|
|
<summary>
|
||
|
|
Reads the settings file based on the <paramref name="staleBehavior" /> specified.
|
||
|
|
</summary>
|
||
|
|
<param name="staleBehavior">See <see cref="T:Microsoft.VisualStudio.RemoteControl.BehaviorOnStale" /> for details about each possible setting.
|
||
|
|
In most cases use the BehaviorOnStale.ReturnStale setting.
|
||
|
|
!! WARNING about using BehaviorOnStale.ForceDownload !!
|
||
|
|
* each server request is billed and costs add up from millions of clients.
|
||
|
|
* the only acceptable use of ForceDownload is very infrequently and if you absolutely cannot function
|
||
|
|
without the latest settings.
|
||
|
|
* keep in mind that even once-per-process-lifetime may be too much if you process starts and stops very
|
||
|
|
frequently.
|
||
|
|
</param>
|
||
|
|
<returns>A Stream that can be used to read the setting file. !Callers must call Dispose on this stream
|
||
|
|
object returned. Or Null is returned in case of failure to get the file (or if server returned
|
||
|
|
NotFound).</returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:Microsoft.VisualStudio.RemoteControl.IRemoteControlClient.ReadFileAsync(Microsoft.VisualStudio.RemoteControl.BehaviorOnStale)">
|
||
|
|
<summary>
|
||
|
|
Reads the settings file based on the <paramref name="staleBehavior" /> specified. This is the Async version
|
||
|
|
of ReadFile method.
|
||
|
|
</summary>
|
||
|
|
<param name="staleBehavior">See <see cref="T:Microsoft.VisualStudio.RemoteControl.BehaviorOnStale" /> for details about each possible setting.
|
||
|
|
In most cases use the BehaviorOnStale.ReturnStale setting.</param>
|
||
|
|
<returns>A Stream that can be used to read the setting file. !Callers must call Dispose on this stream
|
||
|
|
object returned. Or Null is returned in case of failure to get the file (or if server returned
|
||
|
|
NotFound).</returns>
|
||
|
|
</member>
|
||
|
|
<member name="T:Microsoft.VisualStudio.RemoteControl.IRemoteControlHTTPRequestor">
|
||
|
|
<summary>
|
||
|
|
Provides operation to issue HTTP requests to obtain a file, either from the server or from the local IE cache.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="M:Microsoft.VisualStudio.RemoteControl.IRemoteControlHTTPRequestor.GetFileFromServerAsync">
|
||
|
|
<summary>
|
||
|
|
Reads the file from the server url.
|
||
|
|
In case of errors reading the file from the server, returned <see cref="T:Microsoft.VisualStudio.RemoteControl.GetFileResult" /> object's
|
||
|
|
IsSuccessStatusCode value will be false.
|
||
|
|
</summary>
|
||
|
|
<returns>Information about the file obtained from the server</returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:Microsoft.VisualStudio.RemoteControl.IRemoteControlHTTPRequestor.GetFileFromCacheAsync">
|
||
|
|
<summary>
|
||
|
|
Reads the file from the local IE cache only.
|
||
|
|
If the file does not exist in the cache, the returned <see cref="T:Microsoft.VisualStudio.RemoteControl.GetFileResult" /> object's IsCached value
|
||
|
|
will be false and Code will be Unused.
|
||
|
|
</summary>
|
||
|
|
<returns>Information about the file in the IE cache</returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:Microsoft.VisualStudio.RemoteControl.IRemoteControlHTTPRequestor.LastServerRequestErrorSecondsAgoAsync">
|
||
|
|
<summary>
|
||
|
|
Gets the elapsed time (in seconds) since the last error in downloading / revalidating the file from the
|
||
|
|
server.
|
||
|
|
</summary>
|
||
|
|
<returns>Time in seconds since last error or Int.MaxValue if no error has ever occured.</returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:Microsoft.VisualStudio.RemoteControl.IRemoteControlHTTPRequestor.Cancel">
|
||
|
|
<summary>
|
||
|
|
Cancels all in progress HTTP requests. Any future calls to this class should not be made.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="T:Microsoft.VisualStudio.RemoteControl.RemoteControlClient">
|
||
|
|
<summary>
|
||
|
|
Client for the Remote Control Service.
|
||
|
|
This client polls the service for a single settings file and keeps it up-to-date in the local IE cache (which
|
||
|
|
is per-user).
|
||
|
|
Developers may call the <see cref="M:Microsoft.VisualStudio.RemoteControl.RemoteControlClient.ReadFile(Microsoft.VisualStudio.RemoteControl.BehaviorOnStale)" /> or <see cref="M:Microsoft.VisualStudio.RemoteControl.RemoteControlClient.ReadFileAsync(Microsoft.VisualStudio.RemoteControl.BehaviorOnStale)" /> to read settings file.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="M:Microsoft.VisualStudio.RemoteControl.RemoteControlClient.#ctor(System.String,System.String,System.String,System.Int32,System.Int32,System.Int32)">
|
||
|
|
<summary>
|
||
|
|
Creates the client and starts polling.
|
||
|
|
</summary>
|
||
|
|
<param name="hostId">HostId of the settings file (used to construct URL to the file:
|
||
|
|
[baseUrl]/[hostId]/[relativePath]).</param>
|
||
|
|
<param name="baseUrl">Base URL of the service e.g. https://az700632.vo.msecnd.net</param>
|
||
|
|
<param name="relativePath">Relative path used to contruct the full URL to the file:
|
||
|
|
[baseUrl]/[hostId]/[relativePath]</param>
|
||
|
|
<param name="pollingIntervalMins">Optional. Default = 1440 minutes (24 hours). Min allowed = 5 minutes.
|
||
|
|
Polling Interval (in minutes) to check the file on the server when the last request to the server
|
||
|
|
succeeded.</param>
|
||
|
|
<param name="theHttpRequestTimeoutSeconds">Optional. Default = 60 seconds. Maximum allowed = 60 seconds.
|
||
|
|
HTTP request timeout used.</param>
|
||
|
|
<param name="overrideReadFileTelemetryFrequency">Optional. Allows to set how often to send successful
|
||
|
|
ReadFile telemetry, to prevent noise events Default = 1 (meaning post ReadFile telemetry every time). Min
|
||
|
|
allowed is 1.</param>
|
||
|
|
</member>
|
||
|
|
<member name="M:Microsoft.VisualStudio.RemoteControl.RemoteControlClient.#ctor(Microsoft.VisualStudio.RemoteControl.IRemoteControlHTTPRequestor,Microsoft.VisualStudio.Utilities.Internal.IRegistryTools,System.String,System.String,System.String,System.Int32,System.Int32,System.Int32)">
|
||
|
|
<summary>
|
||
|
|
Only for testing. Testing "fake" IE Cache or "fake" server response
|
||
|
|
</summary>
|
||
|
|
<param name="requestor"></param>
|
||
|
|
<param name="theRegistryTools"></param>
|
||
|
|
<param name="hostId"></param>
|
||
|
|
<param name="baseUrl"></param>
|
||
|
|
<param name="relativePath"></param>
|
||
|
|
<param name="pollingIntervalMins"></param>
|
||
|
|
<param name="httpRequestTimeoutSeconds"></param>
|
||
|
|
<param name="maxRandomDownloadDelaySeconds"></param>
|
||
|
|
</member>
|
||
|
|
<member name="M:Microsoft.VisualStudio.RemoteControl.RemoteControlClient.#ctor(Microsoft.VisualStudio.Utilities.Internal.IRegistryTools,Microsoft.VisualStudio.RemoteControl.IFileReader,System.String,System.String,System.String)">
|
||
|
|
<summary>
|
||
|
|
Only for testing. Testing local functionality
|
||
|
|
</summary>
|
||
|
|
<param name="theRegistryTools"></param>
|
||
|
|
<param name="theFileReader"></param>
|
||
|
|
<param name="hostId"></param>
|
||
|
|
<param name="baseUrl"></param>
|
||
|
|
<param name="relativePath"></param>
|
||
|
|
</member>
|
||
|
|
<member name="P:Microsoft.VisualStudio.RemoteControl.RemoteControlClient.TelemetryLogger">
|
||
|
|
<summary>
|
||
|
|
Gets or sets an action which allows setting of a Telemetry Logger to
|
||
|
|
collect telemetry for usage of the Remote Control.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="P:Microsoft.VisualStudio.RemoteControl.RemoteControlClient.TelemetryLogger2">
|
||
|
|
<summary>
|
||
|
|
Gets or sets an action which allows setting of a Telemetry Logger to
|
||
|
|
collect telemetry for usage of the Remote Control. Includes Pii-option.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="P:Microsoft.VisualStudio.RemoteControl.RemoteControlClient.FullUrl">
|
||
|
|
<summary>
|
||
|
|
Gets a full URL used to download to the file.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="P:Microsoft.VisualStudio.RemoteControl.RemoteControlClient.PollingIntervalMins">
|
||
|
|
<summary>
|
||
|
|
Gets a polling Interval to check the file on the server. This setting also determines
|
||
|
|
when a file in the local IE cache is considered stale.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="M:Microsoft.VisualStudio.RemoteControl.RemoteControlClient.ReadFile(Microsoft.VisualStudio.RemoteControl.BehaviorOnStale)">
|
||
|
|
<summary>
|
||
|
|
Reads the settings file based on the <paramref name="staleBehavior" /> specified.
|
||
|
|
</summary>
|
||
|
|
<param name="staleBehavior">See <see cref="T:Microsoft.VisualStudio.RemoteControl.BehaviorOnStale" /> for details about each possible setting.
|
||
|
|
In most cases use the BehaviorOnStale.ReturnStale setting.</param>
|
||
|
|
<returns>A Stream that can be used to read the setting file. !Callers must call Dispose on this stream
|
||
|
|
object returned. Or Null is returned in case of failure to get the file (or if server returned
|
||
|
|
NotFound).</returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:Microsoft.VisualStudio.RemoteControl.RemoteControlClient.ReadFileAsync(Microsoft.VisualStudio.RemoteControl.BehaviorOnStale)">
|
||
|
|
<summary>
|
||
|
|
Reads the settings file based on the <paramref name="staleBehavior" /> specified. This is the Async version
|
||
|
|
of ReadFile method.
|
||
|
|
</summary>
|
||
|
|
<param name="staleBehavior">See <see cref="T:Microsoft.VisualStudio.RemoteControl.BehaviorOnStale" /> for details about each possible setting.
|
||
|
|
In most cases use the BehaviorOnStale.ReturnStale setting.</param>
|
||
|
|
<returns>A Stream that can be used to read the setting file. !Callers must call Dispose on this stream
|
||
|
|
object returned. Or Null is returned in case of failure to get the file (or if server returned
|
||
|
|
NotFound).</returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:Microsoft.VisualStudio.RemoteControl.RemoteControlClient.Dispose">
|
||
|
|
<summary>
|
||
|
|
Disposes of client
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="M:Microsoft.VisualStudio.RemoteControl.RemoteControlClient.CacheUpdateTimerCallback(System.Object,System.Threading.CancellationToken)">
|
||
|
|
<summary>
|
||
|
|
Callback method for the update timer.
|
||
|
|
</summary>
|
||
|
|
<param name="stateInfo">Dummy</param>
|
||
|
|
<param name="token">Cancellation token</param>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:Microsoft.VisualStudio.RemoteControl.RemoteControlClient.EnsureFileIsUpToDateAsync(System.Threading.CancellationToken)">
|
||
|
|
<summary>
|
||
|
|
Determines if a local IE cache copy of the file is up-to-date. If no cached copy is available or the
|
||
|
|
cached copy is not up-to-date, a request is made to the server to download or revalidate the file. The
|
||
|
|
result of the server request is cached.
|
||
|
|
</summary>
|
||
|
|
<param name="cancellationToken">Cancellation token to cancel waiting of operation</param>
|
||
|
|
<returns>Returns True if the copy in the IE cache is up-to-date by the end of the method. False in case of
|
||
|
|
failures that prevent updating file.</returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:Microsoft.VisualStudio.RemoteControl.RemoteControlClient.GetFileAndInstrumentAsync(System.Boolean)">
|
||
|
|
<summary>
|
||
|
|
Get a file and send telemetry events.
|
||
|
|
</summary>
|
||
|
|
<param name="fromServer"></param>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:Microsoft.VisualStudio.RemoteControl.RemoteControlClient.InstrumentGetFile(Microsoft.VisualStudio.RemoteControl.GetFileResult)">
|
||
|
|
<summary>
|
||
|
|
Instruments the usage of GetFileFromCache and GetFileFromServer.
|
||
|
|
</summary>
|
||
|
|
<param name="fileResult"></param>
|
||
|
|
</member>
|
||
|
|
<member name="T:Microsoft.VisualStudio.RemoteControl.RemoteControlHTTPRequestor">
|
||
|
|
<summary>
|
||
|
|
Provides operation to issue HTTP requests to obtain a file, either from the server or from the local IE cache.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="M:Microsoft.VisualStudio.RemoteControl.RemoteControlHTTPRequestor.#ctor(System.String,System.Int32)">
|
||
|
|
<summary>
|
||
|
|
Ctor
|
||
|
|
</summary>
|
||
|
|
<param name="url">Server URL to obtain the settings file</param>
|
||
|
|
<param name="httpRequestTimeoutMillis">Timeout in milliseconds for the HTTP requests issued by this
|
||
|
|
class</param>
|
||
|
|
</member>
|
||
|
|
<member name="M:Microsoft.VisualStudio.RemoteControl.RemoteControlHTTPRequestor.Microsoft#VisualStudio#RemoteControl#IRemoteControlHTTPRequestor#GetFileFromServerAsync">
|
||
|
|
<summary>
|
||
|
|
Reads the file from the server url.
|
||
|
|
In case of errors reading the file from the server, returned <see cref="T:Microsoft.VisualStudio.RemoteControl.GetFileResult" /> object's
|
||
|
|
IsSuccessStatusCode value will be false.
|
||
|
|
</summary>
|
||
|
|
<returns>Information about the file obtained from the server</returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:Microsoft.VisualStudio.RemoteControl.RemoteControlHTTPRequestor.Microsoft#VisualStudio#RemoteControl#IRemoteControlHTTPRequestor#GetFileFromCacheAsync">
|
||
|
|
<summary>
|
||
|
|
Reads the file from the local IE cache only.
|
||
|
|
If the file does not exist in the cache, the returned <see cref="T:Microsoft.VisualStudio.RemoteControl.GetFileResult" /> object's IsFromCache value
|
||
|
|
will be false and Code will be Unused.
|
||
|
|
</summary>
|
||
|
|
<returns>Information about the file in the IE cache</returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:Microsoft.VisualStudio.RemoteControl.RemoteControlHTTPRequestor.Microsoft#VisualStudio#RemoteControl#IRemoteControlHTTPRequestor#LastServerRequestErrorSecondsAgoAsync">
|
||
|
|
<summary>
|
||
|
|
Gets the elapsed time (in seconds) since the last error in downloading / revalidating the file from the
|
||
|
|
server.
|
||
|
|
</summary>
|
||
|
|
<returns>Time in seconds since last error or Int.MaxValue if no error has ever occured.</returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:Microsoft.VisualStudio.RemoteControl.RemoteControlHTTPRequestor.Microsoft#VisualStudio#RemoteControl#IRemoteControlHTTPRequestor#Cancel">
|
||
|
|
<summary>
|
||
|
|
Cancels all in progress HTTP requests. Any future calls to this class should not be made.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="M:Microsoft.VisualStudio.RemoteControl.RemoteControlHTTPRequestor.ExtractAgeHeaderValue(System.Net.HttpWebResponse)">
|
||
|
|
<summary>
|
||
|
|
Extracts the value of Age header from <paramref name="resp" />.
|
||
|
|
</summary>
|
||
|
|
<param name="resp">HTTP response</param>
|
||
|
|
<returns>If Age header is present on <paramref name="resp" />can is valid,
|
||
|
|
returns its value. Otherwise null.</returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:Microsoft.VisualStudio.RemoteControl.RemoteControlHTTPRequestor.CreateHttpRequest(System.String)">
|
||
|
|
<summary>
|
||
|
|
In .Net 4.0 and above, in some cases, ConfigurationErrorsException
|
||
|
|
will not be catch without the HandleProcessCorruptedStateExceptions
|
||
|
|
and SecurityCritical attributes. The method should not be async.
|
||
|
|
|
||
|
|
See Bug 172014 and
|
||
|
|
https://msdn.microsoft.com/en-us/magazine/dd419661.aspx
|
||
|
|
</summary>
|
||
|
|
<param name="requestUrl"></param>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:Microsoft.VisualStudio.RemoteControl.RemoteControlHTTPRequestor.GetFile(System.String,System.Int32,System.Net.Cache.HttpRequestCachePolicy)">
|
||
|
|
<summary>
|
||
|
|
This is the HTTP-facing method in the class. It essentially performs all functions of
|
||
|
|
1. sending an HTTP request for the file
|
||
|
|
2. if the response is from the server, ensuring that it is added to the IE cache
|
||
|
|
3. additonal logic to cache error responses in the IE cache. By default error
|
||
|
|
responses are not cached.
|
||
|
|
</summary>
|
||
|
|
<param name="requestUrl"></param>
|
||
|
|
<param name="requestTimeoutMillis"></param>
|
||
|
|
<param name="cachePolicy">Specifies chache policy to use when sending the request</param>
|
||
|
|
<returns>Result of the file lookup. See <see cref="T:Microsoft.VisualStudio.RemoteControl.GetFileResult" /> for details.</returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:Microsoft.VisualStudio.RemoteControl.RemoteControlHTTPRequestor.WrapInSeekableStreamAsync(System.IO.Stream)">
|
||
|
|
<summary>
|
||
|
|
Copies all data in <paramref name="s" /> to a new Memory Stream to allow seeking.
|
||
|
|
</summary>
|
||
|
|
<param name="s">Original Stream</param>
|
||
|
|
<returns>A new in memory stream</returns>
|
||
|
|
</member>
|
||
|
|
<member name="T:Microsoft.VisualStudio.RemoteControl.RemoteControlUri">
|
||
|
|
<summary>
|
||
|
|
URI with optional redirect.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="P:Microsoft.VisualStudio.RemoteControl.RemoteControlUri.IsLocalFile">
|
||
|
|
<summary>
|
||
|
|
Gets a value indicating whether the URI points to a local file.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="P:Microsoft.VisualStudio.RemoteControl.RemoteControlUri.FullUrl">
|
||
|
|
<summary>
|
||
|
|
Gets a full URI string.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="P:Microsoft.VisualStudio.RemoteControl.RemoteControlUri.HostId">
|
||
|
|
<summary>
|
||
|
|
Gets a Host Id which was used to initialize the URI.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="M:Microsoft.VisualStudio.RemoteControl.RemoteControlUri.Create(Microsoft.VisualStudio.Utilities.Internal.IRegistryTools,System.String,System.String,System.String)">
|
||
|
|
<summary>
|
||
|
|
Creates a new URI with optional redirect.
|
||
|
|
</summary>
|
||
|
|
<param name="registryTools"></param>
|
||
|
|
<param name="hostId"></param>
|
||
|
|
<param name="baseUrl"></param>
|
||
|
|
<param name="relativePath"></param>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:Microsoft.VisualStudio.RemoteControl.UriEx.SplitLastSegment(System.Uri)">
|
||
|
|
<summary>
|
||
|
|
Split the last path segment from the given URI.
|
||
|
|
</summary>
|
||
|
|
<param name="uri"></param>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="M:Microsoft.VisualStudio.RemoteControl.UriEx.AddSegment(System.Uri,System.String)">
|
||
|
|
<summary>
|
||
|
|
Add a path segment to the given URI. The path segment may contain trailling '/'.
|
||
|
|
</summary>
|
||
|
|
<param name="uri"></param>
|
||
|
|
<param name="segment"></param>
|
||
|
|
<returns></returns>
|
||
|
|
</member>
|
||
|
|
<member name="T:Microsoft.VisualStudio.RemoteControl.WinINetHelper">
|
||
|
|
<summary>
|
||
|
|
Provides a helper method to write empty files to the local IE cache. This is useful for writing HTTP error
|
||
|
|
responses to the cache. Although caching of error responses is entirely allowed by HTTP protocol, The
|
||
|
|
System.Net library does not add error responses to the cache. So, this helper library is used to call
|
||
|
|
wininet.dll functions to do so.
|
||
|
|
</summary>
|
||
|
|
</member>
|
||
|
|
<member name="M:Microsoft.VisualStudio.RemoteControl.WinINetHelper.WriteErrorResponseToCache(System.String,System.Net.HttpStatusCode)">
|
||
|
|
<summary>
|
||
|
|
Adds an empty file to the local IE cache with the <paramref name="status" />header for the
|
||
|
|
specified<paramref name="url" />.
|
||
|
|
</summary>
|
||
|
|
<param name="url">URL for which to add the cache entry</param>
|
||
|
|
<param name="status">Status of the response to cache</param>
|
||
|
|
<returns>True if operation succeeded. Otherwise false.</returns>
|
||
|
|
</member>
|
||
|
|
</members>
|
||
|
|
<Signature xmlns="http://www.w3.org/2000/09/xmldsig#"><SignedInfo><CanonicalizationMethod Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315" /><SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha256" /><Reference URI=""><Transforms><Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature" /><Transform Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315" /></Transforms><DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256" /><DigestValue>LliLyEAbU3J+WgGUtbiQsPB5Fu5iUIov7F9EvJycIGo=</DigestValue></Reference></SignedInfo><SignatureValue>tMomN1uEWdEKmrGGokQmUyqb5gi8rOdXJXUBRWGe+UkTtSuOeoEjguZIKVY++QTZi+ZwMCsJ/yY3GZyW2KI/+pQEw7uBHiiZIzTtFTQNzzzYKr6C84QfW7NLRuUYaDyneMHyYmV3WTkR37kxnM7Q3lrD0fZ2UGLPvXOikq7y+2HJcua3r9IIq2M1e/VqruELTagePdMFp2OLv2/dbT+qnCE4whu+VYCNfrf6ivVtdEzlmKTUDC6Bsfx9GWzPiw9s4DmNVb24RebR+0diRjqat4LbbCB+Uw2f/OjcGSX2USjyrkN2ePlrhcxEGPPBFLZJBiKgzrUoVs3pAT/rjZ2J/w==</SignatureValue><KeyInfo><KeyValue><RSAKeyValue><Modulus>6yM7GOtjJiq83q4Ju1HJ7vg7kh3YM0WVQiBovQmpRa4cLYivtxSA85TmG7P88x8Liwt4Yq+ecFYB6GguJYkMEOtMFckdexGT2uAUNvAuQEZcan7Xadx/Ea11m1cr0GlJwUFWTO91w8hldaFD2RhxlrYHarQVHetFY5xTyAkn/KZxYoreob0sR+SFViNIjp36nV2KD1lLVVDJlaltcgV9DbW0JUhyFOoZT76Pf7qir5IxVBQNi2wvQFkGyZh/tbjNJeJw0inwqnHL3SOZd84xJPclElJodSEIQxZ/uUi9iZpwhdI2RGeH+RxO8pAz/qIgN0Pn4SgrHoPtGhB4vg0T2Q==</Modulus><Exponent>AQAB</Exponent></RSAKeyValue></KeyValue><X509Data><X509Certificate>MIIGAzCCA+ugAwIBAgITMwAAAs3zZL/41ExdUQAAAAACzTANBgkqhkiG9w0BAQsFADB+MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSgwJgYDVQQDEx9NaWNyb3NvZnQgQ29kZSBTaWduaW5nIFBDQSAyMDExMB4XDTIyMDUxMjIwNDYwMloXDTIzMDUxMTIwNDYwMlowdDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEeMBwGA1UEAxMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6yM7GOtjJiq83q4Ju1HJ7vg7kh3YM0WVQiBovQmpRa4cLYivtxSA85TmG7P88x8Liwt4Yq+ecFYB6GguJYkMEOtMFckdexGT2uAUNvAuQEZcan7Xadx/Ea11m1cr0GlJwUFWTO91w8hldaFD2RhxlrYHarQVHetFY5xTyAkn/KZxYoreob0sR+SFViNIjp36nV2KD1lLVVDJlaltcgV9DbW0JUhyFOoZT76Pf7qir5IxVBQNi2wvQFkGyZh/tbjNJeJw0inwqnHL3SOZd84xJPclElJodSEIQxZ/uUi9iZpwhdI2RGeH+RxO8pAz/qIgN0Pn4SgrHoPtGhB4vg0T2QIDAQABo4IBgjCCAX4wHwYDVR0lBBgwFgYKKwYBBAGCN0wIAQYIKwYBBQUHAwMwHQYDVR0OBBYEFNFsph+Aj+7NfskJLRMG3C0LkfWcMFQGA1UdEQRNMEukSTBHMS0wKwYDVQQLEyRNaWNyb3NvZnQgSXJlbGFuZCBPcGVyYXRpb25zIExpbWl0ZWQxFjAUBgNVBAUTDTIzMDAxMis0NzA1MzAwHwYDVR0jBBgwFoAUSG5k5VAF04KqFzc3IrVtqMp1ApUwVAYDVR0fBE0wSzBJoEegRYZDaHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraW9wcy9jcmwvTWljQ29kU2lnUENBMjAxMV8yMDExLTA3LTA4LmNybDBhBggrBgEFBQcBAQRVMFMwUQYIKwYBBQUHMAKGRWh0dHA6Ly93d3cubWljcm9zb2Z0LmNvbS9wa2lvcHMvY2VydHMvTWljQ29kU2lnUENBMjAxMV8yMDExLTA3LTA4LmNydDAMBgNVHRMBAf8EAjAAMA0GCSqGSIb3DQEBCwUAA4ICAQBOy0rrjTmwgVmLrbcSQIIpVyfdhqclf304slx2f/S2817PzHypz8EcnZZgNmpNKxliwxYfPcwFhxSPLfSS8KXf1UaFRN/lss0yLJHWwZx239co6P/tLaR5Z66BSXXA0jCLB/k+89wpWPulp40k3raYNWP6Szi12aWY2Hl0IhcKPRuZc1HEnfGFUDT0ABiApdiUUmgjZcwHSBQheTzSqF2ybRKg3D2fKA6zPSnTu06lBOVangXug4IGNbGWJ0A/vy1pc+Q9MAq4jYBkP01lnsTMMJxKpSMH5CHDRcaNEDQ/+mGvQ0wFMpJNkihkj7dJC7R8TRJ9hib3DbX6IVWP29LbshdOXlxN3HbWGW3hqFNcUIsT2QJU3bS5nhTZcvNrgVW8mwGeFLdfBf/1K7oFUPVFHStbmJnPtknUUEAnHCsFxjrmIGdVC1truT8n1sc6OAUfvudzgf7WV0Kc+DpIAWXqrPWGmCxXykZUB1bZkIIRR8web/1haJ8Q1Zbz8ctoKGtLvWfmZSKb6KGUb5ujrV8XQIzAXFgQLJwUa/zo+bN+ehA3X9pf7C8CxWBOtbfjBIjWHctKVy+oDdw8U1X9qoycVxZBX4404rJ3bnR7ILhDJPJhLZ78KPXzkik+qER4TPbGeB04P00zI1JY5jd5gWFgFiORMXQtYp7qINMaypjllQ==</X509Certificate><X509Certificate>MIIHejCCBWKgAwIBAgIKYQ6Q0gAAAAAAAzANBgkqhkiG9w0BAQsFADCBiDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEyMDAGA1UEAxMpTWljcm9zb2Z0IFJvb3QgQ2VydGlmaWNhdGUgQXV0aG9yaXR5IDIwMTEwHhcNMTEwNzA4MjA1OTA5WhcNMjYwNzA4MjEwOTA5WjB+MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSgwJgYDVQQDEx9NaWNyb3NvZnQgQ29kZSBTaWduaW5nIFBDQSAyMDExMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAq/D6chAcLq3YbqqCEE00uvK2WCGfQhsqa+laUKq4BjgaBEm6f8MMHt03a8YS2Av
|