spelling: comments in src/System.Management.Automation/engine/remoting/common

This commit is contained in:
Josh Soref
2016-08-28 05:29:21 +00:00
parent 64bd97801a
commit 435c4e3474
13 changed files with 59 additions and 59 deletions
@@ -105,7 +105,7 @@ namespace System.Management.Automation
}
/// <summary>
/// Clone from IClonable
/// Clone from ICloneable
/// </summary>
public object Clone()
{
@@ -483,7 +483,7 @@ namespace System.Management.Automation.Remoting
/// <summary>
/// Connect to Hyper-V socket server. This is a blocking call until a
/// connection occurs or the timeout time has ellapsed.
/// connection occurs or the timeout time has elapsed.
/// </summary>
/// <param name="networkCredential">The credential used for authentication</param>
/// <param name="configurationName">The configuration name of the PS session</param>
@@ -566,8 +566,8 @@ namespace System.Management.Automation.Remoting
//
// There are 3 cases for the responseString received above.
// - "FAIL": credential is invalid
// - "PASS": credentail is valid, but PowerShell Direct in VM does not support configuration (Server 2016 TP4 and before)
// - "CONF": credentail is valid, and PowerShell Direct in VM supports configuration (Server 2016 TP5 and later)
// - "PASS": credential is valid, but PowerShell Direct in VM does not support configuration (Server 2016 TP4 and before)
// - "CONF": credential is valid, and PowerShell Direct in VM supports configuration (Server 2016 TP5 and later)
//
//
@@ -264,7 +264,7 @@ namespace System.Management.Automation.Remoting
#region Properties
/// <summary>
/// Exception reson for listener end event. Can be null
/// Exception reason for listener end event. Can be null
/// which indicates listener thread end is not due to an error.
/// </summary>
public Exception Reason
@@ -503,7 +503,7 @@ namespace System.Management.Automation.Remoting
s_syncObject = new object();
// All PowerShell instances will start with the named pipe
// and listner created and running.
// and listener created and running.
if (Platform.IsWindows)
{
IPCNamedPipeServerEnabled = true;
@@ -962,7 +962,7 @@ namespace System.Management.Automation.Remoting
/// <summary>
/// Connect to named pipe server. This is a blocking call until a
/// connection occurs or the timeout time has ellapsed.
/// connection occurs or the timeout time has elapsed.
/// </summary>
/// <param name="timeout">Connection attempt timeout in milliseconds</param>
public void Connect(
@@ -545,7 +545,7 @@ namespace System.Management.Automation.Runspaces
}
/// <summary>
/// AuthenticationMaechanism converted to WSManAuthenticationMechanism type.
/// AuthenticationMechanism converted to WSManAuthenticationMechanism type.
/// This is internal.
/// </summary>
internal WSManAuthenticationMechanism WSManAuthenticationMechanism { get; private set; } = WSManAuthenticationMechanism.WSMAN_FLAG_DEFAULT_AUTHENTICATION;
@@ -709,7 +709,7 @@ namespace System.Management.Automation.Runspaces
/// <summary>
/// Specifies that no encryption will be used when doing remote operations over
/// http. Unencrypted traffix is not allowed by default and must be enabled in
/// http. Unencrypted traffic is not allowed by default and must be enabled in
/// the local configuration
/// </summary>
public bool NoEncryption { get; set; }
@@ -925,7 +925,7 @@ namespace System.Management.Automation.Runspaces
/// default server life time and default open
/// timeout
/// </summary>
/// <param name="uri">uri of remote runspae</param>
/// <param name="uri">uri of remote runspace</param>
/// <exception cref="ArgumentException">When an
/// uri representing an invalid path is specified</exception>
public WSManConnectionInfo(Uri uri)
@@ -1089,7 +1089,7 @@ namespace System.Management.Automation.Runspaces
/// <summary>
/// Converts <paramref name="rsCI"/> to a WSManConnectionInfo. If conversion succeeds extracts
/// the propery..otherwise returns default value
/// the property..otherwise returns default value
/// </summary>
/// <param name="rsCI"></param>
/// <param name="property"></param>
@@ -1246,7 +1246,7 @@ namespace System.Management.Automation.Runspaces
/// Used to resolve authentication from the parameters chosen by the user.
/// User has the following options:
/// 1. AuthMechanism + Credential
/// 2. CertiticateThumbPrint
/// 2. CertificateThumbPrint
///
/// All the above are mutually exclusive.
/// </summary>
@@ -1603,7 +1603,7 @@ namespace System.Management.Automation.Runspaces
/// ThumbPrint of a certificate used for connecting to a remote machine.
/// When this is specified, you dont need to supply credential and authentication
/// mechanism.
/// Will always be empty to signfy that this is not supported.
/// Will always be empty to signify that this is not supported.
/// </summary>
public override string CertificateThumbprint
{
@@ -2056,7 +2056,7 @@ namespace System.Management.Automation.Runspaces
/// <summary>
/// Create a process through native Win32 APIs and return StdIn, StdOut, StdError reader/writers
/// This needs to be done via Win32 APIs because managed code creates anonymous synchronous pipes
/// for redirected StdIn/Out and SSH (and PSRP) require asynchrous (overlapped) pipes, which must
/// for redirected StdIn/Out and SSH (and PSRP) require asynchronous (overlapped) pipes, which must
/// be through named pipes. Managed code for named pipes is unreliable and so this is done via
/// P-Invoking native APIs.
/// </summary>
@@ -2362,7 +2362,7 @@ namespace System.Management.Automation.Runspaces
/// ThumbPrint of a certificate used for connecting to a remote machine.
/// When this is specified, you dont need to supply credential and authentication
/// mechanism.
/// Will always be null to signfy that this is not supported.
/// Will always be null to signify that this is not supported.
/// </summary>
public override string CertificateThumbprint
{
@@ -2483,7 +2483,7 @@ namespace System.Management.Automation.Runspaces
/// ThumbPrint of a certificate used for connecting to a remote machine.
/// When this is specified, you dont need to supply credential and authentication
/// mechanism.
/// Will always be null to signfy that this is not supported.
/// Will always be null to signify that this is not supported.
/// </summary>
public override string CertificateThumbprint
{
@@ -856,7 +856,7 @@ namespace System.Management.Automation
/// <summary>
/// This method generates a Remoting data structure handler message for
/// that contains a repsonse to SetMaxRunspaces or SetMinRunspaces
/// that contains a response to SetMaxRunspaces or SetMinRunspaces
/// </summary>
/// <param name="clientRunspacePoolId">id of the clientRunspacePool</param>
/// <param name="callId">call id of the call at client</param>
@@ -896,7 +896,7 @@ namespace System.Management.Automation
/// --------------------------------------------------------------------------
/// | D | TI | RPID | PID | Data | Type |
/// ---------------------------------------------------------------------------
/// | S | Runspace | CRPID | 0 | null |GetAvailalbeRunspaces |
/// | S | Runspace | CRPID | 0 | null |GetAvailableRunspaces |
/// | | Pool | | | | |
/// --------------------------------------------------------------------------
internal static RemoteDataObject GenerateGetAvailableRunspaces(Guid clientRunspacePoolId,
@@ -914,13 +914,13 @@ namespace System.Management.Automation
/// <summary>
/// This method generates a remoting data structure handler message for
/// transfering a roles public key to the other side
/// transferring a roles public key to the other side
/// </summary>
/// <param name="runspacePoolId">runspace pool id</param>
/// <param name="publicKey">public key to send across</param>
/// <param name="destination">destination that this message is
/// targetted to</param>
/// <returns>data strucutre message</returns>
/// targeted to</param>
/// <returns>data structure message</returns>
/// The message format is as under for this message
/// --------------------------------------------------------------------------
/// | D | TI | RPID | PID | Data | Type |
@@ -946,7 +946,7 @@ namespace System.Management.Automation
/// requesting a public key from the client to the server
/// </summary>
/// <param name="runspacePoolId">runspace pool id</param>
/// <returns>data strucutre message</returns>
/// <returns>data structure message</returns>
/// The message format is as under for this message
/// --------------------------------------------------------------------------
/// | D | TI | RPID | PID | Data | Type |
@@ -969,7 +969,7 @@ namespace System.Management.Automation
/// </summary>
/// <param name="runspacePoolId">runspace pool id</param>
/// <param name="encryptedSessionKey">encrypted session key</param>
/// <returns>data strucutre message</returns>
/// <returns>data structure message</returns>
/// The message format is as under for this message
/// --------------------------------------------------------------------------
/// | D | TI | RPID | PID | Data | Type |
@@ -1312,7 +1312,7 @@ namespace System.Management.Automation
/// --------------------------------------------------------------------------------------
/// | D | TI | RPID | PID | Action | Data | Type |
/// --------------------------------------------------------------------------------------
/// | S |PowerShell | CRPID | CPID | Data | intput data | PowerShellInput |
/// | S |PowerShell | CRPID | CPID | Data | input data | PowerShellInput |
/// | | | | | | | |
/// --------------------------------------------------------------------------------------
internal static RemoteDataObject GeneratePowerShellInput(object data, Guid clientRemoteRunspacePoolId,
@@ -1998,7 +1998,7 @@ namespace System.Management.Automation
}
/// <summary>
/// Generates RunspacePoolInitInfo object from a recevied PSObject
/// Generates RunspacePoolInitInfo object from a received PSObject
/// </summary>
/// <param name="dataAsPSObject">data object to decode</param>
/// <returns>RunspacePoolInitInfo generated</returns>
@@ -2049,7 +2049,7 @@ namespace System.Management.Automation
}
/// <summary>
/// Gets the exception if any from the serializaed state info object
/// Gets the exception if any from the serialized state info object
/// </summary>
/// <param name="stateInfo"></param>
/// <returns></returns>
@@ -417,7 +417,7 @@ namespace System.Management.Automation.Remoting
// check if the incoming call is GetBufferContents
// if so do the following:
// (a) Specify a warning message that the server is
// attemping to read the screen buffer contents
// attempting to read the screen buffer contents
// on screen and it has been blocked
// (b) Modify the message so that call is not executed
else if (MethodId == RemoteHostMethodId.GetBufferContents)
@@ -483,8 +483,8 @@ namespace System.Management.Automation.Remoting
}
else if (obj is PSObject && IsGenericIEnumerableOfInt(type))
{
// we cannot create an instance of interface type like IEnumberable
// Since a Collection implements IEnumberable, falling back to use
// we cannot create an instance of interface type like IEnumerable
// Since a Collection implements IEnumerable, falling back to use
// that.
return DecodeCollection((PSObject)obj, typeof(Collection<int>));
}
@@ -129,11 +129,11 @@ namespace System.Management.Automation.Remoting
/// <summary>
/// Creates a RemoteDataObject by deserialzing <paramref name="data"/>.
/// Creates a RemoteDataObject by deserializing <paramref name="data"/>.
/// </summary>
/// <param name="serializedDataStream"></param>
/// <param name="defragmentor">
/// Defragmetor used to deserialize an object.
/// Defragmentor used to deserialize an object.
/// </param>
/// <returns></returns>
internal static RemoteDataObject<T> CreateFrom(Stream serializedDataStream, Fragmentor defragmentor)
@@ -170,7 +170,7 @@ namespace System.Management.Automation.Remoting
#region Serialize / Deserialize
/// <summary>
/// Seriliazes the object into the stream specified. The serialization mechanism uses
/// Serializes the object into the stream specified. The serialization mechanism uses
/// UTF8 encoding to encode data.
/// </summary>
/// <param name="streamToWriteTo"></param>
@@ -193,7 +193,7 @@ namespace System.Management.Automation.Remoting
/// <summary>
/// Serializes only the header portion of the object. ie., runspaceId,
/// powerShellId, destinaion and dataType.
/// powerShellId, destination and dataType.
/// </summary>
/// <param name="streamToWriteTo">
/// place where the serialized data is stored into.
@@ -17,7 +17,7 @@ namespace System.Management.Automation.Remoting
/// <summary>
/// This class is used to hold a fragment of remoting PSObject for transporting to remote computer.
///
/// A large remoting PSObject will be broken into fragments. Each fragment has a ObjectId and a FragementId.
/// A large remoting PSObject will be broken into fragments. Each fragment has a ObjectId and a FragmentId.
/// The first fragment has a StartFragment marker. The last fragment also an EndFragment marker.
/// These fragments can be reassembled on the receiving
/// end by sequencing the fragment ids.
@@ -271,7 +271,7 @@ namespace System.Management.Automation.Remoting
/// If fragmentBytes is null.
/// </exception>
/// <exception cref="ArgumentException">
/// If startIndex is negative or fragmentBytes is not large enought to hold the entire header of
/// If startIndex is negative or fragmentBytes is not large enough to hold the entire header of
/// a binary encoded FragmentedRemoteObject.
/// </exception>
internal static long GetObjectId(byte[] fragmentBytes, int startIndex)
@@ -305,7 +305,7 @@ namespace System.Management.Automation.Remoting
/// If fragmentBytes is null.
/// </exception>
/// <exception cref="ArgumentException">
/// If startIndex is negative or fragmentBytes is not large enought to hold the entire header of
/// If startIndex is negative or fragmentBytes is not large enough to hold the entire header of
/// a binary encoded FragmentedRemoteObject.
/// </exception>
internal static long GetFragmentId(byte[] fragmentBytes, int startIndex)
@@ -340,7 +340,7 @@ namespace System.Management.Automation.Remoting
/// If fragmentBytes is null.
/// </exception>
/// <exception cref="ArgumentException">
/// If startIndex is negative or fragmentBytes is not large enought to hold the entire header of
/// If startIndex is negative or fragmentBytes is not large enough to hold the entire header of
/// a binary encoded FragmentedRemoteObject.
/// </exception>
internal static bool GetIsStartFragment(byte[] fragmentBytes, int startIndex)
@@ -369,7 +369,7 @@ namespace System.Management.Automation.Remoting
/// If fragmentBytes is null.
/// </exception>
/// <exception cref="ArgumentException">
/// If startIndex is negative or fragmentBytes is not large enought to hold the entire header of
/// If startIndex is negative or fragmentBytes is not large enough to hold the entire header of
/// a binary encoded FragmentedRemoteObject.
/// </exception>
internal static bool GetIsEndFragment(byte[] fragmentBytes, int startIndex)
@@ -398,7 +398,7 @@ namespace System.Management.Automation.Remoting
/// If fragmentBytes is null.
/// </exception>
/// <exception cref="ArgumentException">
/// If startIndex is negative or fragmentBytes is not large enought to hold the entire header of
/// If startIndex is negative or fragmentBytes is not large enough to hold the entire header of
/// a binary encoded FragmentedRemoteObject.
/// </exception>
internal static int GetBlobLength(byte[] fragmentBytes, int startIndex)
@@ -613,7 +613,7 @@ namespace System.Management.Automation.Remoting
/// <summary>
/// Returns a byte[] which holds data of fragment size (or) serialized data of
/// one object, which ever is greater. If data is not currently available, then
/// the callback is registerd and called whenever the data is available.
/// the callback is registered and called whenever the data is available.
/// </summary>
/// <param name="callback">
/// callback to call once the data becomes available.
@@ -955,7 +955,7 @@ namespace System.Management.Automation.Remoting
/// <summary>
/// This class performs the fragmentation as well as defragmentation operations of large objects to be sent
/// to the other side. A large remoting PSObject will be broken into fragments. Each fragment has a ObjectId
/// and a FragementId. The last fragment also has an end of fragment marker. These fragments can be reassembled
/// and a FragmentId. The last fragment also has an end of fragment marker. These fragments can be reassembled
/// on the receiving end by sequencing the fragment ids.
/// </summary>
internal class Fragmentor
@@ -1005,7 +1005,7 @@ namespace System.Management.Automation.Remoting
/// The object to be fragmented. Caller should make sure this is not null.
/// </param>
/// <param name="dataToBeSent">
/// Caller specified dataToStore to which the fragements are added
/// Caller specified dataToStore to which the fragments are added
/// one-by-one
/// </param>
internal void Fragment<T>(RemoteDataObject<T> obj, SerializedDataStream dataToBeSent)
@@ -145,7 +145,7 @@ namespace System.Management.Automation
NegotiationReceived = 7,
/// <summary>
/// Used by server to wait for negotation from client.
/// Used by server to wait for negotiation from client.
/// </summary>
NegotiationPending = 8,
@@ -181,9 +181,9 @@ namespace System.Management.Automation
/// <summary>
/// for Server - Have sent a request to the remote end to
/// send a public key
/// for Cleint - have received a PK request from server
/// for Client - have received a PK request from server
/// </summary>
/// <remarks>Applicable to both cleint and server</remarks>
/// <remarks>Applicable to both client and server</remarks>
EstablishedAndKeyRequested = 14,
/// <summary>
@@ -392,7 +392,7 @@ namespace System.Management.Automation
/// <summary>
/// In the presence of ambient remoting, the command assumes
/// all responsibility for targetting the remote computer;
/// all responsibility for targeting the remote computer;
/// PowerShell Remoting is not supported.
/// </summary>
OwnedByCommand
@@ -7,7 +7,7 @@ using System.Management.Automation.Remoting;
namespace System.Management.Automation
{
/// <summary>
/// This abstract class is designed to provide InstandId and self identification for
/// This abstract class is designed to provide InstanceId and self identification for
/// client and server remote session classes.
/// </summary>
internal abstract class RemoteSession
@@ -241,7 +241,7 @@ namespace System.Management.Automation.Remoting
PSDefaultSessionOptionDescription = 1002,
PSSenderInfoDescription = 1004,
// IPC for Backgroud jobs related errors: 2000
// IPC for Background jobs related errors: 2000
IPCUnknownNodeType = 2001,
IPCInsufficientDataforElement = 2002,
IPCWrongAttributeCountForDataElement = 2003,
@@ -296,7 +296,7 @@ namespace System.Management.Automation.Remoting
#region Constructors
/// <summary>
/// Default construtor.
/// Default constructor.
/// </summary>
public PSRemotingDataStructureException()
: base(PSRemotingErrorInvariants.FormatResourceString(RemotingErrorIdStrings.DefaultRemotingExceptionMessage, typeof(PSRemotingDataStructureException).FullName))
@@ -350,7 +350,7 @@ namespace System.Management.Automation.Remoting
/// This constuctor takes an inner exception and an error id.
/// </summary>
/// <param name="innerException">
/// Inner excetion.
/// Inner exception.
/// </param>
/// <param name="resourceString">
/// The resource string in the base resource file.
@@ -460,7 +460,7 @@ namespace System.Management.Automation.Remoting
/// This constuctor takes an inner exception and an error id.
/// </summary>
/// <param name="innerException">
/// Inner excetion.
/// Inner exception.
/// </param>
/// <param name="resourceString">
/// The resource string in the base resource file.
@@ -602,7 +602,7 @@ namespace System.Management.Automation.Remoting
/// This constuctor takes an inner exception and an error id.
/// </summary>
/// <param name="innerException">
/// Inner excetion.
/// Inner exception.
/// </param>
/// <param name="resourceString">
/// The resource string in the base resource file.
@@ -64,10 +64,10 @@ namespace System.Management.Automation.Remoting
internal abstract class IThrottleOperation
{
/// <summary>
/// This method should handle the actual operation whcih need to be
/// This method should handle the actual operation which need to be
/// controlled and performed. Examples of this can be Opening remote
/// runspace, invoking expression in a remote runspace, etc. Once
/// an event is successfully recieved as a result of this function,
/// an event is successfully received as a result of this function,
/// the handler has to ensure that it raises an OperationComplete
/// event with StartComplete or StopComplete for the throttle manager
/// to handle
@@ -80,7 +80,7 @@ namespace System.Management.Automation.Remoting
/// remote runspaces, the user might hit ctrl-C. In which case, the
/// pending runspaces to be opened will actually be signalled through
/// this method to stop operation and return back. This method also
/// needs to be asynchronous. Once an event is successfully recieved
/// needs to be asynchronous. Once an event is successfully received
/// as a result of this function, the handler has to ensure that it
/// raises an OperationComplete event with StopComplete for the
/// throttle manager to handle. It is important that this function
@@ -91,7 +91,7 @@ namespace System.Management.Automation.Remoting
/// <summary>
/// Event which will be triggered when the operation is complete. It is
/// assumed that all the operations perfomed by StartOperation and
/// assumed that all the operations performed by StartOperation and
/// StopOperation are asynchronous. The submitter of operations may
/// subscribe to this event to know when it's complete (or it can handle
/// the synchronization with its scheduler) and the throttle
@@ -107,7 +107,7 @@ namespace System.Management.Automation.Remoting
/// In the initial implementation of ThrottleManager stopping
/// individual operations was not supported. When the support
/// for stopping individual operations was added, there was
/// the following problem - if an opertaion is not there in
/// the following problem - if an operation is not there in
/// the pending queue and in the startOperationQueue as well,
/// then the following two scenarios are possible
/// (a) Operation was started and start completed
@@ -139,7 +139,7 @@ namespace System.Management.Automation.Remoting
/// <summary>
/// Class which handles the throttling operations. This class is singleton and therefore
/// when used either across cmdlets or at the infrastructure level it will ensure that
/// there aren't more operations by way of accumalation than what is intended by design.
/// there aren't more operations by way of accumulation than what is intended by design.
///
/// This class contains a queue of items, each of which has the
/// <see cref="System.Management.Automation.Remoting.IThrottleOperation">
@@ -600,7 +600,7 @@ namespace System.Management.Automation.Remoting
/// <summary>
/// Dispose method of IDisposable. Any cmdlet that uses
/// the throttle manager needs to call this method from its
/// Dipose method
/// Dispose method
/// </summary>
public void Dispose()
{