11using System ;
2+ using System . Globalization ;
23using System . Threading ;
34
45namespace Renci . SshNet
@@ -19,36 +20,36 @@ private ForwardedPortStatus(int value, string name)
1920 _name = name ;
2021 }
2122
22- public override bool Equals ( object obj )
23+ public override bool Equals ( object other )
2324 {
24- if ( ReferenceEquals ( obj , null ) )
25+ if ( ReferenceEquals ( other , null ) )
2526 return false ;
2627
27- if ( ReferenceEquals ( this , obj ) )
28+ if ( ReferenceEquals ( this , other ) )
2829 return true ;
2930
30- var forwardedPortStatus = obj as ForwardedPortStatus ;
31+ var forwardedPortStatus = other as ForwardedPortStatus ;
3132 if ( forwardedPortStatus == null )
3233 return false ;
3334
3435 return forwardedPortStatus . _value == _value ;
3536 }
3637
37- public static bool operator == ( ForwardedPortStatus c1 , ForwardedPortStatus c2 )
38+ public static bool operator == ( ForwardedPortStatus left , ForwardedPortStatus right )
3839 {
3940 // check if lhs is null
40- if ( ReferenceEquals ( c1 , null ) )
41+ if ( ReferenceEquals ( left , null ) )
4142 {
4243 // check if both lhs and rhs are null
43- return ( ReferenceEquals ( c2 , null ) ) ;
44+ return ( ReferenceEquals ( right , null ) ) ;
4445 }
4546
46- return c1 . Equals ( c2 ) ;
47+ return left . Equals ( right ) ;
4748 }
4849
49- public static bool operator != ( ForwardedPortStatus c1 , ForwardedPortStatus c2 )
50+ public static bool operator != ( ForwardedPortStatus left , ForwardedPortStatus right )
5051 {
51- return ! ( c1 == c2 ) ;
52+ return ! ( left == right ) ;
5253 }
5354
5455 public override int GetHashCode ( )
@@ -61,13 +62,25 @@ public override string ToString()
6162 return _name ;
6263 }
6364
65+ /// <summary>
66+ /// Returns a value indicating whether <paramref name="status"/> has been changed to <see cref="Stopping"/>.
67+ /// </summary>
68+ /// <param name="status">The status to transition from.</param>
69+ /// <returns>
70+ /// <c>true</c> if <paramref name="status"/> has been changed to <see cref="Stopping"/>; otherwise, <c>false</c>.
71+ /// </returns>
72+ /// <exception cref="InvalidOperationException">Cannot transition <paramref name="status"/> to <see cref="Stopping"/>.</exception>
73+ /// <remarks>
74+ /// While a transition from <see cref="Stopped"/> to <see cref="Stopping"/> is not possible, this method will
75+ /// return <c>false</c> for any such attempts. This is related to concurrency.
76+ /// </remarks>
6477 public static bool ToStopping ( ref ForwardedPortStatus status )
6578 {
6679 // attempt to transition from Started to Stopping
6780 var previousStatus = Interlocked . CompareExchange ( ref status , Stopping , Started ) ;
6881 if ( previousStatus == Stopping || previousStatus == Stopped )
6982 {
70- // status is already Stopping or Stopped, so no transition to Stopped is necessary
83+ // status is already Stopping or Stopped, so no transition to Stopping is necessary
7184 return false ;
7285 }
7386
@@ -79,14 +92,32 @@ public static bool ToStopping(ref ForwardedPortStatus status)
7992 previousStatus = Interlocked . CompareExchange ( ref status , Stopping , Starting ) ;
8093 if ( previousStatus == Stopping || previousStatus == Stopped )
8194 {
82- // status is already Stopping or Stopped, so no transition to Stopped is necessary
95+ // status is already Stopping or Stopped, so no transition to Stopping is necessary
8396 return false ;
8497 }
8598
8699 // we've successfully transitioned from Starting to Stopping
87- return status == Stopping ;
100+ if ( status == Stopping )
101+ return true ;
102+
103+ // there's no valid transition from status to Stopping
104+ throw new InvalidOperationException ( string . Format ( "Forwarded port cannot transition from '{0}' to '{1}'." ,
105+ previousStatus ,
106+ Stopping ) ) ;
88107 }
89108
109+ /// <summary>
110+ /// Returns a value indicating whether <paramref name="status"/> has been changed to <see cref="Starting"/>.
111+ /// </summary>
112+ /// <param name="status">The status to transition from.</param>
113+ /// <returns>
114+ /// <c>true</c> if <paramref name="status"/> has been changed to <see cref="Starting"/>; otherwise, <c>false</c>.
115+ /// </returns>
116+ /// <exception cref="InvalidOperationException">Cannot transition <paramref name="status"/> to <see cref="Starting"/>.</exception>
117+ /// <remarks>
118+ /// While a transition from <see cref="Started"/> to <see cref="Starting"/> is not possible, this method will
119+ /// return <c>false</c> for any such attempts. This is related to concurrency.
120+ /// </remarks>
90121 public static bool ToStarting ( ref ForwardedPortStatus status )
91122 {
92123 // attemp to transition from Stopped to Starting
@@ -101,8 +132,10 @@ public static bool ToStarting(ref ForwardedPortStatus status)
101132 if ( status == Starting )
102133 return true ;
103134
104- // there's no valid transition from Stopping to Starting
105- throw new InvalidOperationException ( "Forwarded port is stopping." ) ;
135+ // there's no valid transition from status to Starting
136+ throw new InvalidOperationException ( string . Format ( "Forwarded port cannot transition from '{0}' to '{1}'." ,
137+ previousStatus ,
138+ Starting ) ) ;
106139 }
107140 }
108141}
0 commit comments