-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathGMap.NET.Core.xml
More file actions
3360 lines (3350 loc) · 156 KB
/
GMap.NET.Core.xml
File metadata and controls
3360 lines (3350 loc) · 156 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0"?>
<doc>
<assembly>
<name>GMap.NET.Core</name>
</assembly>
<members>
<member name="P:GMap.NET.CacheProviders.MemoryCache.Capacity">
<summary>
the amount of tiles in MB to keep in memmory, default: 22MB, if each ~100Kb it's ~222 tiles
</summary>
</member>
<member name="P:GMap.NET.CacheProviders.MemoryCache.Size">
<summary>
current memmory cache size in MB
</summary>
</member>
<member name="T:GMap.NET.Internals.SocksHttpWebRequest">
<summary>
http://ditrans.blogspot.com/2009/03/making-witty-work-with-socks-proxy.html
</summary>
</member>
<member name="T:GMap.NET.Internals.DrawTile">
<summary>
struct for drawing tile
</summary>
</member>
<member name="T:GMap.NET.Internals.FastResourceLock">
<summary>
Provides a fast resource (reader-writer) lock.
</summary>
<remarks>
There are three types of acquire methods in this lock:
Normal methods (AcquireExclusive, AcquireShared) are preferred
for general purpose use.
Busy wait methods (SpinAcquireExclusive, SpinAcquireShared) are
preferred if very little time is spent while the lock is acquired.
However, these do not give exclusive acquires precedence over
shared acquires.
Try methods (TryAcquireExclusive, TryAcquireShared) can be used to
quickly test if the lock is available.
Note that all three types of functions can be used concurrently
in the same class instance.
</remarks>
</member>
<member name="M:GMap.NET.Internals.FastResourceLock.#ctor">
<summary>
Creates a FastResourceLock.
</summary>
</member>
<member name="M:GMap.NET.Internals.FastResourceLock.Dispose">
<summary>
Disposes resources associated with the FastResourceLock.
</summary>
</member>
<member name="M:GMap.NET.Internals.FastResourceLock.AcquireExclusive">
<summary>
Acquires the lock in exclusive mode, blocking
if necessary.
</summary>
<remarks>
Exclusive acquires are given precedence over shared
acquires.
</remarks>
</member>
<member name="M:GMap.NET.Internals.FastResourceLock.AcquireShared">
<summary>
Acquires the lock in shared mode, blocking
if necessary.
</summary>
<remarks>
Exclusive acquires are given precedence over shared
acquires.
</remarks>
</member>
<member name="M:GMap.NET.Internals.FastResourceLock.ConvertExclusiveToShared">
<summary>
Converts the ownership mode from exclusive to shared.
</summary>
<remarks>
Exclusive acquires are not given a chance to acquire
the lock before this function does - as a result,
this function will never block.
</remarks>
</member>
<member name="M:GMap.NET.Internals.FastResourceLock.EnsureEventCreated(System.IntPtr@)">
<summary>
Checks if the specified event has been created, and
if not, creates it.
</summary>
<param name="handle">A reference to the event handle.</param>
</member>
<member name="M:GMap.NET.Internals.FastResourceLock.GetStatistics">
<summary>
Gets statistics information for the lock.
</summary>
<returns>A structure containing statistics.</returns>
</member>
<member name="M:GMap.NET.Internals.FastResourceLock.ReleaseExclusive">
<summary>
Releases the lock in exclusive mode.
</summary>
</member>
<member name="M:GMap.NET.Internals.FastResourceLock.ReleaseShared">
<summary>
Releases the lock in shared mode.
</summary>
</member>
<member name="M:GMap.NET.Internals.FastResourceLock.SpinAcquireExclusive">
<summary>
Acquires the lock in exclusive mode, busy waiting
if necessary.
</summary>
<remarks>
Exclusive acquires are *not* given precedence over shared
acquires for busy wait methods.
</remarks>
</member>
<member name="M:GMap.NET.Internals.FastResourceLock.SpinAcquireShared">
<summary>
Acquires the lock in shared mode, busy waiting
if necessary.
</summary>
<remarks>
Exclusive acquires are *not* given precedence over shared
acquires for busy wait methods.
</remarks>
</member>
<member name="M:GMap.NET.Internals.FastResourceLock.SpinConvertSharedToExclusive">
<summary>
Converts the ownership mode from shared to exclusive,
busy waiting if necessary.
</summary>
</member>
<member name="M:GMap.NET.Internals.FastResourceLock.TryAcquireExclusive">
<summary>
Attempts to acquire the lock in exclusive mode.
</summary>
<returns>Whether the lock was acquired.</returns>
</member>
<member name="M:GMap.NET.Internals.FastResourceLock.TryAcquireShared">
<summary>
Attempts to acquire the lock in shared mode.
</summary>
<returns>Whether the lock was acquired.</returns>
</member>
<member name="M:GMap.NET.Internals.FastResourceLock.TryConvertSharedToExclusive">
<summary>
Attempts to convert the ownership mode from shared
to exclusive.
</summary>
<returns>Whether the lock was converted.</returns>
</member>
<member name="P:GMap.NET.Internals.FastResourceLock.ExclusiveWaiters">
<summary>
Gets the number of exclusive waiters.
</summary>
</member>
<member name="P:GMap.NET.Internals.FastResourceLock.Owned">
<summary>
Gets whether the lock is owned in either
exclusive or shared mode.
</summary>
</member>
<member name="P:GMap.NET.Internals.FastResourceLock.SharedOwners">
<summary>
Gets the number of shared owners.
</summary>
</member>
<member name="P:GMap.NET.Internals.FastResourceLock.SharedWaiters">
<summary>
Gets the number of shared waiters.
</summary>
</member>
<member name="F:GMap.NET.Internals.FastResourceLock.Statistics.AcqExcl">
<summary>
The number of times the lock has been acquired in exclusive mode.
</summary>
</member>
<member name="F:GMap.NET.Internals.FastResourceLock.Statistics.AcqShrd">
<summary>
The number of times the lock has been acquired in shared mode.
</summary>
</member>
<member name="F:GMap.NET.Internals.FastResourceLock.Statistics.AcqExclCont">
<summary>
The number of times either the fast path was retried due to the
spin count or the exclusive waiter went to sleep.
</summary>
<remarks>
This number is usually much higher than AcqExcl, and indicates
a good spin count if AcqExclSlp is very small.
</remarks>
</member>
<member name="F:GMap.NET.Internals.FastResourceLock.Statistics.AcqShrdCont">
<summary>
The number of times either the fast path was retried due to the
spin count or the shared waiter went to sleep.
</summary>
<remarks>
This number is usually much higher than AcqShrd, and indicates
a good spin count if AcqShrdSlp is very small.
</remarks>
</member>
<member name="F:GMap.NET.Internals.FastResourceLock.Statistics.AcqExclSlp">
<summary>
The number of times exclusive waiters have gone to sleep.
</summary>
<remarks>
If this number is high and not much time is spent in the
lock, consider increasing the spin count.
</remarks>
</member>
<member name="F:GMap.NET.Internals.FastResourceLock.Statistics.AcqShrdSlp">
<summary>
The number of times shared waiters have gone to sleep.
</summary>
<remarks>
If this number is high and not much time is spent in the
lock, consider increasing the spin count.
</remarks>
</member>
<member name="F:GMap.NET.Internals.FastResourceLock.Statistics.PeakExclWtrsCount">
<summary>
The highest number of exclusive waiters at any one time.
</summary>
</member>
<member name="F:GMap.NET.Internals.FastResourceLock.Statistics.PeakShrdWtrsCount">
<summary>
The highest number of shared waiters at any one time.
</summary>
</member>
<member name="T:Org.Mentalis.Network.ProxySocket.Authentication.AuthMethod">
<summary>
Implements a SOCKS authentication scheme.
</summary>
<remarks>This is an abstract class; it must be inherited.</remarks>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.Authentication.AuthMethod.#ctor(System.Net.Sockets.Socket)">
<summary>
Initializes an AuthMethod instance.
</summary>
<param name="server">The socket connection with the proxy server.</param>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.Authentication.AuthMethod.Authenticate">
<summary>
Authenticates the user.
</summary>
<exception cref="T:Org.Mentalis.Network.ProxySocket.ProxyException">Authentication with the proxy server failed.</exception>
<exception cref="T:System.Net.ProtocolViolationException">The proxy server uses an invalid protocol.</exception>
<exception cref="T:System.Net.Sockets.SocketException">An operating system error occurs while accessing the Socket.</exception>
<exception cref="T:System.ObjectDisposedException">The Socket has been closed.</exception>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.Authentication.AuthMethod.BeginAuthenticate(Org.Mentalis.Network.ProxySocket.HandShakeComplete)">
<summary>
Authenticates the user asynchronously.
</summary>
<param name="callback">The method to call when the authentication is complete.</param>
<exception cref="T:Org.Mentalis.Network.ProxySocket.ProxyException">Authentication with the proxy server failed.</exception>
<exception cref="T:System.Net.ProtocolViolationException">The proxy server uses an invalid protocol.</exception>
<exception cref="T:System.Net.Sockets.SocketException">An operating system error occurs while accessing the Socket.</exception>
<exception cref="T:System.ObjectDisposedException">The Socket has been closed.</exception>
</member>
<member name="F:Org.Mentalis.Network.ProxySocket.Authentication.AuthMethod.m_Buffer">
<summary>Holds the value of the Buffer property.</summary>
</member>
<member name="F:Org.Mentalis.Network.ProxySocket.Authentication.AuthMethod.m_Server">
<summary>Holds the value of the Server property.</summary>
</member>
<member name="F:Org.Mentalis.Network.ProxySocket.Authentication.AuthMethod.CallBack">
<summary>Holds the address of the method to call when the proxy has authenticated the client.</summary>
</member>
<member name="F:Org.Mentalis.Network.ProxySocket.Authentication.AuthMethod.m_Received">
<summary>Holds the value of the Received property.</summary>
</member>
<member name="P:Org.Mentalis.Network.ProxySocket.Authentication.AuthMethod.Server">
<summary>
Gets or sets the socket connection with the proxy server.
</summary>
<value>The socket connection with the proxy server.</value>
</member>
<member name="P:Org.Mentalis.Network.ProxySocket.Authentication.AuthMethod.Buffer">
<summary>
Gets or sets a byt array that can be used to store data.
</summary>
<value>A byte array to store data.</value>
</member>
<member name="P:Org.Mentalis.Network.ProxySocket.Authentication.AuthMethod.Received">
<summary>
Gets or sets the number of bytes that have been received from the remote proxy server.
</summary>
<value>An integer that holds the number of bytes that have been received from the remote proxy server.</value>
</member>
<member name="T:Org.Mentalis.Network.ProxySocket.Authentication.AuthNone">
<summary>
This class implements the 'No Authentication' scheme.
</summary>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.Authentication.AuthNone.#ctor(System.Net.Sockets.Socket)">
<summary>
Initializes an AuthNone instance.
</summary>
<param name="server">The socket connection with the proxy server.</param>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.Authentication.AuthNone.Authenticate">
<summary>
Authenticates the user.
</summary>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.Authentication.AuthNone.BeginAuthenticate(Org.Mentalis.Network.ProxySocket.HandShakeComplete)">
<summary>
Authenticates the user asynchronously.
</summary>
<param name="callback">The method to call when the authentication is complete.</param>
<remarks>This method immediately calls the callback method.</remarks>
</member>
<member name="T:Org.Mentalis.Network.ProxySocket.Authentication.AuthUserPass">
<summary>
This class implements the 'username/password authentication' scheme.
</summary>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.Authentication.AuthUserPass.#ctor(System.Net.Sockets.Socket,System.String,System.String)">
<summary>
Initializes a new AuthUserPass instance.
</summary>
<param name="server">The socket connection with the proxy server.</param>
<param name="user">The username to use.</param>
<param name="pass">The password to use.</param>
<exception cref="T:System.ArgumentNullException"><c>user</c> -or- <c>pass</c> is null.</exception>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.Authentication.AuthUserPass.GetAuthenticationBytes">
<summary>
Creates an array of bytes that has to be sent if the user wants to authenticate with the username/password authentication scheme.
</summary>
<returns>An array of bytes that has to be sent if the user wants to authenticate with the username/password authentication scheme.</returns>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.Authentication.AuthUserPass.Authenticate">
<summary>
Starts the authentication process.
</summary>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.Authentication.AuthUserPass.BeginAuthenticate(Org.Mentalis.Network.ProxySocket.HandShakeComplete)">
<summary>
Starts the asynchronous authentication process.
</summary>
<param name="callback">The method to call when the authentication is complete.</param>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.Authentication.AuthUserPass.OnSent(System.IAsyncResult)">
<summary>
Called when the authentication bytes have been sent.
</summary>
<param name="ar">Stores state information for this asynchronous operation as well as any user-defined data.</param>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.Authentication.AuthUserPass.OnReceive(System.IAsyncResult)">
<summary>
Called when the socket received an authentication reply.
</summary>
<param name="ar">Stores state information for this asynchronous operation as well as any user-defined data.</param>
</member>
<member name="F:Org.Mentalis.Network.ProxySocket.Authentication.AuthUserPass.m_Username">
<summary>Holds the value of the Username property.</summary>
</member>
<member name="F:Org.Mentalis.Network.ProxySocket.Authentication.AuthUserPass.m_Password">
<summary>Holds the value of the Password property.</summary>
</member>
<member name="P:Org.Mentalis.Network.ProxySocket.Authentication.AuthUserPass.Username">
<summary>
Gets or sets the username to use when authenticating with the proxy server.
</summary>
<value>The username to use when authenticating with the proxy server.</value>
<exception cref="T:System.ArgumentNullException">The specified value is null.</exception>
</member>
<member name="P:Org.Mentalis.Network.ProxySocket.Authentication.AuthUserPass.Password">
<summary>
Gets or sets the password to use when authenticating with the proxy server.
</summary>
<value>The password to use when authenticating with the proxy server.</value>
<exception cref="T:System.ArgumentNullException">The specified value is null.</exception>
</member>
<member name="T:Org.Mentalis.Network.ProxySocket.IAsyncProxyResult">
<summary>
A class that implements the IAsyncResult interface. Objects from this class are returned by the BeginConnect method of the ProxySocket class.
</summary>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.IAsyncProxyResult.Init(System.Object)">
<summary>Initializes the internal variables of this object</summary>
<param name="stateObject">An object that contains state information for this request.</param>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.IAsyncProxyResult.Reset">
<summary>Initializes the internal variables of this object</summary>
</member>
<member name="F:Org.Mentalis.Network.ProxySocket.IAsyncProxyResult.m_Completed">
<summary>Used internally to represent the state of the asynchronous request</summary>
</member>
<member name="F:Org.Mentalis.Network.ProxySocket.IAsyncProxyResult.m_StateObject">
<summary>Holds the value of the StateObject property.</summary>
</member>
<member name="F:Org.Mentalis.Network.ProxySocket.IAsyncProxyResult.m_WaitHandle">
<summary>Holds the value of the WaitHandle property.</summary>
</member>
<member name="P:Org.Mentalis.Network.ProxySocket.IAsyncProxyResult.IsCompleted">
<summary>Gets a value that indicates whether the server has completed processing the call. It is illegal for the server to use any client supplied resources outside of the agreed upon sharing semantics after it sets the IsCompleted property to "true". Thus, it is safe for the client to destroy the resources after IsCompleted property returns "true".</summary>
<value>A boolean that indicates whether the server has completed processing the call.</value>
</member>
<member name="P:Org.Mentalis.Network.ProxySocket.IAsyncProxyResult.CompletedSynchronously">
<summary>Gets a value that indicates whether the BeginXXXX call has been completed synchronously. If this is detected in the AsyncCallback delegate, it is probable that the thread that called BeginInvoke is the current thread.</summary>
<value>Returns false.</value>
</member>
<member name="P:Org.Mentalis.Network.ProxySocket.IAsyncProxyResult.AsyncState">
<summary>Gets an object that was passed as the state parameter of the BeginXXXX method call.</summary>
<value>The object that was passed as the state parameter of the BeginXXXX method call.</value>
</member>
<member name="P:Org.Mentalis.Network.ProxySocket.IAsyncProxyResult.AsyncWaitHandle">
<summary>
The AsyncWaitHandle property returns the WaitHandle that can use to perform a WaitHandle.WaitOne or WaitAny or WaitAll. The object which implements IAsyncResult need not derive from the System.WaitHandle classes directly. The WaitHandle wraps its underlying synchronization primitive and should be signaled after the call is completed. This enables the client to wait for the call to complete instead polling. The Runtime supplies a number of waitable objects that mirror Win32 synchronization primitives e.g. ManualResetEvent, AutoResetEvent and Mutex.
WaitHandle supplies methods that support waiting for such synchronization objects to become signaled with "any" or "all" semantics i.e. WaitHandle.WaitOne, WaitAny and WaitAll. Such methods are context aware to avoid deadlocks. The AsyncWaitHandle can be allocated eagerly or on demand. It is the choice of the IAsyncResult implementer.
</summary>
<value>The WaitHandle associated with this asynchronous result.</value>
</member>
<member name="T:Org.Mentalis.Network.ProxySocket.ProxyException">
<summary>
The exception that is thrown when a proxy error occurs.
</summary>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.ProxyException.#ctor">
<summary>
Initializes a new instance of the ProxyException class.
</summary>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.ProxyException.#ctor(System.String)">
<summary>
Initializes a new instance of the ProxyException class.
</summary>
<param name="message">The message that describes the error.</param>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.ProxyException.#ctor(System.Int32)">
<summary>
Initializes a new instance of the ProxyException class.
</summary>
<param name="socks5Error">The error number returned by a SOCKS5 server.</param>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.ProxyException.Socks5ToString(System.Int32)">
<summary>
Converts a SOCKS5 error number to a human readable string.
</summary>
<param name="socks5Error">The error number returned by a SOCKS5 server.</param>
<returns>A string representation of the specified SOCKS5 error number.</returns>
</member>
<member name="T:Org.Mentalis.Network.ProxySocket.ProxyTypes">
<summary>
Specifies the type of proxy servers that an instance of the ProxySocket class can use.
</summary>
</member>
<member name="F:Org.Mentalis.Network.ProxySocket.ProxyTypes.None">
<summary>No proxy server; the ProxySocket object behaves exactly like an ordinary Socket object.</summary>
</member>
<member name="F:Org.Mentalis.Network.ProxySocket.ProxyTypes.Socks4">
<summary>A SOCKS4[A] proxy server.</summary>
</member>
<member name="F:Org.Mentalis.Network.ProxySocket.ProxyTypes.Socks5">
<summary>A SOCKS5 proxy server.</summary>
</member>
<member name="T:Org.Mentalis.Network.ProxySocket.ProxySocket">
<summary>
Implements a Socket class that can connect trough a SOCKS proxy server.
</summary>
<remarks>This class implements SOCKS4[A] and SOCKS5.<br>It does not, however, implement the BIND commands, so you cannot .</br></remarks>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.ProxySocket.#ctor(System.Net.Sockets.AddressFamily,System.Net.Sockets.SocketType,System.Net.Sockets.ProtocolType)">
<summary>
Initializes a new instance of the ProxySocket class.
</summary>
<param name="addressFamily">One of the AddressFamily values.</param>
<param name="socketType">One of the SocketType values.</param>
<param name="protocolType">One of the ProtocolType values.</param>
<exception cref="T:System.Net.Sockets.SocketException">The combination of addressFamily, socketType, and protocolType results in an invalid socket.</exception>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.ProxySocket.#ctor(System.Net.Sockets.AddressFamily,System.Net.Sockets.SocketType,System.Net.Sockets.ProtocolType,System.String)">
<summary>
Initializes a new instance of the ProxySocket class.
</summary>
<param name="addressFamily">One of the AddressFamily values.</param>
<param name="socketType">One of the SocketType values.</param>
<param name="protocolType">One of the ProtocolType values.</param>
<param name="proxyUsername">The username to use when authenticating with the proxy server.</param>
<exception cref="T:System.Net.Sockets.SocketException">The combination of addressFamily, socketType, and protocolType results in an invalid socket.</exception>
<exception cref="T:System.ArgumentNullException"><c>proxyUsername</c> is null.</exception>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.ProxySocket.#ctor(System.Net.Sockets.AddressFamily,System.Net.Sockets.SocketType,System.Net.Sockets.ProtocolType,System.String,System.String)">
<summary>
Initializes a new instance of the ProxySocket class.
</summary>
<param name="addressFamily">One of the AddressFamily values.</param>
<param name="socketType">One of the SocketType values.</param>
<param name="protocolType">One of the ProtocolType values.</param>
<param name="proxyUsername">The username to use when authenticating with the proxy server.</param>
<param name="proxyPassword">The password to use when authenticating with the proxy server.</param>
<exception cref="T:System.Net.Sockets.SocketException">The combination of addressFamily, socketType, and protocolType results in an invalid socket.</exception>
<exception cref="T:System.ArgumentNullException"><c>proxyUsername</c> -or- <c>proxyPassword</c> is null.</exception>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.ProxySocket.Connect(System.Net.EndPoint)">
<summary>
Establishes a connection to a remote device.
</summary>
<param name="remoteEP">An EndPoint that represents the remote device.</param>
<exception cref="T:System.ArgumentNullException">The remoteEP parameter is a null reference (Nothing in Visual Basic).</exception>
<exception cref="T:System.Net.Sockets.SocketException">An operating system error occurs while accessing the Socket.</exception>
<exception cref="T:System.ObjectDisposedException">The Socket has been closed.</exception>
<exception cref="T:Org.Mentalis.Network.ProxySocket.ProxyException">An error occured while talking to the proxy server.</exception>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.ProxySocket.Connect(System.String,System.Int32)">
<summary>
Establishes a connection to a remote device.
</summary>
<param name="host">The remote host to connect to.</param>
<param name="port">The remote port to connect to.</param>
<exception cref="T:System.ArgumentNullException">The host parameter is a null reference (Nothing in Visual Basic).</exception>
<exception cref="T:System.ArgumentException">The port parameter is invalid.</exception>
<exception cref="T:System.Net.Sockets.SocketException">An operating system error occurs while accessing the Socket.</exception>
<exception cref="T:System.ObjectDisposedException">The Socket has been closed.</exception>
<exception cref="T:Org.Mentalis.Network.ProxySocket.ProxyException">An error occured while talking to the proxy server.</exception>
<remarks>If you use this method with a SOCKS4 server, it will let the server resolve the hostname. Not all SOCKS4 servers support this 'remote DNS' though.</remarks>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.ProxySocket.BeginConnect(System.Net.EndPoint,System.AsyncCallback,System.Object)">
<summary>
Begins an asynchronous request for a connection to a network device.
</summary>
<param name="remoteEP">An EndPoint that represents the remote device.</param>
<param name="callback">The AsyncCallback delegate.</param>
<param name="state">An object that contains state information for this request.</param>
<returns>An IAsyncResult that references the asynchronous connection.</returns>
<exception cref="T:System.ArgumentNullException">The remoteEP parameter is a null reference (Nothing in Visual Basic).</exception>
<exception cref="T:System.Net.Sockets.SocketException">An operating system error occurs while creating the Socket.</exception>
<exception cref="T:System.ObjectDisposedException">The Socket has been closed.</exception>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.ProxySocket.BeginConnect(System.String,System.Int32,System.AsyncCallback,System.Object)">
<summary>
Begins an asynchronous request for a connection to a network device.
</summary>
<param name="host">The host to connect to.</param>
<param name="port">The port on the remote host to connect to.</param>
<param name="callback">The AsyncCallback delegate.</param>
<param name="state">An object that contains state information for this request.</param>
<returns>An IAsyncResult that references the asynchronous connection.</returns>
<exception cref="T:System.ArgumentNullException">The host parameter is a null reference (Nothing in Visual Basic).</exception>
<exception cref="T:System.ArgumentException">The port parameter is invalid.</exception>
<exception cref="T:System.Net.Sockets.SocketException">An operating system error occurs while creating the Socket.</exception>
<exception cref="T:System.ObjectDisposedException">The Socket has been closed.</exception>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.ProxySocket.EndConnect(System.IAsyncResult)">
<summary>
Ends a pending asynchronous connection request.
</summary>
<param name="asyncResult">Stores state information for this asynchronous operation as well as any user-defined data.</param>
<exception cref="T:System.ArgumentNullException">The asyncResult parameter is a null reference (Nothing in Visual Basic).</exception>
<exception cref="T:System.ArgumentException">The asyncResult parameter was not returned by a call to the BeginConnect method.</exception>
<exception cref="T:System.Net.Sockets.SocketException">An operating system error occurs while accessing the Socket.</exception>
<exception cref="T:System.ObjectDisposedException">The Socket has been closed.</exception>
<exception cref="T:System.InvalidOperationException">EndConnect was previously called for the asynchronous connection.</exception>
<exception cref="T:Org.Mentalis.Network.ProxySocket.ProxyException">The proxy server refused the connection.</exception>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.ProxySocket.BeginDns(System.String,Org.Mentalis.Network.ProxySocket.HandShakeComplete)">
<summary>
Begins an asynchronous request to resolve a DNS host name or IP address in dotted-quad notation to an IPAddress instance.
</summary>
<param name="host">The host to resolve.</param>
<param name="callback">The method to call when the hostname has been resolved.</param>
<returns>An IAsyncResult instance that references the asynchronous request.</returns>
<exception cref="T:System.Net.Sockets.SocketException">There was an error while trying to resolve the host.</exception>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.ProxySocket.OnResolved(System.IAsyncResult)">
<summary>
Called when the specified hostname has been resolved.
</summary>
<param name="asyncResult">The result of the asynchronous operation.</param>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.ProxySocket.OnConnect(System.IAsyncResult)">
<summary>
Called when the Socket is connected to the remote host.
</summary>
<param name="asyncResult">The result of the asynchronous operation.</param>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.ProxySocket.OnHandShakeComplete(System.Exception)">
<summary>
Called when the Socket has finished talking to the proxy server and is ready to relay data.
</summary>
<param name="error">The error to throw when the EndConnect method is called.</param>
</member>
<member name="F:Org.Mentalis.Network.ProxySocket.ProxySocket.m_State">
<summary>Holds the value of the State property.</summary>
</member>
<member name="F:Org.Mentalis.Network.ProxySocket.ProxySocket.m_ProxyEndPoint">
<summary>Holds the value of the ProxyEndPoint property.</summary>
</member>
<member name="F:Org.Mentalis.Network.ProxySocket.ProxySocket.m_ProxyType">
<summary>Holds the value of the ProxyType property.</summary>
</member>
<member name="F:Org.Mentalis.Network.ProxySocket.ProxySocket.m_ProxyUser">
<summary>Holds the value of the ProxyUser property.</summary>
</member>
<member name="F:Org.Mentalis.Network.ProxySocket.ProxySocket.m_ProxyPass">
<summary>Holds the value of the ProxyPass property.</summary>
</member>
<member name="F:Org.Mentalis.Network.ProxySocket.ProxySocket.CallBack">
<summary>Holds a pointer to the method that should be called when the Socket is connected to the remote device.</summary>
</member>
<member name="F:Org.Mentalis.Network.ProxySocket.ProxySocket.m_AsyncResult">
<summary>Holds the value of the AsyncResult property.</summary>
</member>
<member name="F:Org.Mentalis.Network.ProxySocket.ProxySocket.m_ToThrow">
<summary>Holds the value of the ToThrow property.</summary>
</member>
<member name="F:Org.Mentalis.Network.ProxySocket.ProxySocket.m_RemotePort">
<summary>Holds the value of the RemotePort property.</summary>
</member>
<member name="P:Org.Mentalis.Network.ProxySocket.ProxySocket.ProxyEndPoint">
<summary>
Gets or sets the EndPoint of the proxy server.
</summary>
<value>An IPEndPoint object that holds the IP address and the port of the proxy server.</value>
</member>
<member name="P:Org.Mentalis.Network.ProxySocket.ProxySocket.ProxyType">
<summary>
Gets or sets the type of proxy server to use.
</summary>
<value>One of the ProxyTypes values.</value>
</member>
<member name="P:Org.Mentalis.Network.ProxySocket.ProxySocket.State">
<summary>
Gets or sets a user-defined object.
</summary>
<value>The user-defined object.</value>
</member>
<member name="P:Org.Mentalis.Network.ProxySocket.ProxySocket.ProxyUser">
<summary>
Gets or sets the username to use when authenticating with the proxy.
</summary>
<value>A string that holds the username that's used when authenticating with the proxy.</value>
<exception cref="T:System.ArgumentNullException">The specified value is null.</exception>
</member>
<member name="P:Org.Mentalis.Network.ProxySocket.ProxySocket.ProxyPass">
<summary>
Gets or sets the password to use when authenticating with the proxy.
</summary>
<value>A string that holds the password that's used when authenticating with the proxy.</value>
<exception cref="T:System.ArgumentNullException">The specified value is null.</exception>
</member>
<member name="P:Org.Mentalis.Network.ProxySocket.ProxySocket.AsyncResult">
<summary>
Gets or sets the asynchronous result object.
</summary>
<value>An instance of the IAsyncProxyResult class.</value>
</member>
<member name="P:Org.Mentalis.Network.ProxySocket.ProxySocket.ToThrow">
<summary>
Gets or sets the exception to throw when the EndConnect method is called.
</summary>
<value>An instance of the Exception class (or subclasses of Exception).</value>
</member>
<member name="P:Org.Mentalis.Network.ProxySocket.ProxySocket.RemotePort">
<summary>
Gets or sets the remote port the user wants to connect to.
</summary>
<value>An integer that specifies the port the user wants to connect to.</value>
</member>
<member name="T:Org.Mentalis.Network.ProxySocket.Socks4Handler">
<summary>
Implements the SOCKS4[A] protocol.
</summary>
</member>
<member name="T:Org.Mentalis.Network.ProxySocket.SocksHandler">
<summary>
Implements a specific version of the SOCKS protocol. This is an abstract class; it must be inherited.
</summary>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.SocksHandler.#ctor(System.Net.Sockets.Socket,System.String)">
<summary>
Initilizes a new instance of the SocksHandler class.
</summary>
<param name="server">The socket connection with the proxy server.</param>
<param name="user">The username to use when authenticating with the server.</param>
<exception cref="T:System.ArgumentNullException"><c>server</c> -or- <c>user</c> is null.</exception>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.SocksHandler.PortToBytes(System.Int32)">
<summary>
Converts a port number to an array of bytes.
</summary>
<param name="port">The port to convert.</param>
<returns>An array of two bytes that represents the specified port.</returns>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.SocksHandler.ReadBytes(System.Int32)">
<summary>
Reads a specified number of bytes from the Server socket.
</summary>
<param name="count">The number of bytes to return.</param>
<returns>An array of bytes.</returns>
<exception cref="T:System.ArgumentException">The number of bytes to read is invalid.</exception>
<exception cref="T:System.Net.Sockets.SocketException">An operating system error occurs while accessing the Socket.</exception>
<exception cref="T:System.ObjectDisposedException">The Socket has been closed.</exception>
</member>
<member name="F:Org.Mentalis.Network.ProxySocket.SocksHandler.m_Server">
<summary>Holds the value of the Server property.</summary>
</member>
<member name="F:Org.Mentalis.Network.ProxySocket.SocksHandler.m_Username">
<summary>Holds the value of the Username property.</summary>
</member>
<member name="F:Org.Mentalis.Network.ProxySocket.SocksHandler.m_AsyncResult">
<summary>Holds the value of the AsyncResult property.</summary>
</member>
<member name="F:Org.Mentalis.Network.ProxySocket.SocksHandler.m_Buffer">
<summary>Holds the value of the Buffer property.</summary>
</member>
<member name="F:Org.Mentalis.Network.ProxySocket.SocksHandler.m_Received">
<summary>Holds the value of the Received property.</summary>
</member>
<member name="F:Org.Mentalis.Network.ProxySocket.SocksHandler.ProtocolComplete">
<summary>Holds the address of the method to call when the SOCKS protocol has been completed.</summary>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.SocksHandler.Negotiate(System.String,System.Int32)">
<summary>
Starts negotiating with a SOCKS proxy server.
</summary>
<param name="host">The remote server to connect to.</param>
<param name="port">The remote port to connect to.</param>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.SocksHandler.Negotiate(System.Net.IPEndPoint)">
<summary>
Starts negotiating with a SOCKS proxy server.
</summary>
<param name="remoteEP">The remote endpoint to connect to.</param>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.SocksHandler.BeginNegotiate(System.Net.IPEndPoint,Org.Mentalis.Network.ProxySocket.HandShakeComplete,System.Net.IPEndPoint)">
<summary>
Starts negotiating asynchronously with a SOCKS proxy server.
</summary>
<param name="remoteEP">An IPEndPoint that represents the remote device. </param>
<param name="callback">The method to call when the connection has been established.</param>
<param name="proxyEndPoint">The IPEndPoint of the SOCKS proxy server.</param>
<returns>An IAsyncProxyResult that references the asynchronous connection.</returns>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.SocksHandler.BeginNegotiate(System.String,System.Int32,Org.Mentalis.Network.ProxySocket.HandShakeComplete,System.Net.IPEndPoint)">
<summary>
Starts negotiating asynchronously with a SOCKS proxy server.
</summary>
<param name="host">The remote server to connect to.</param>
<param name="port">The remote port to connect to.</param>
<param name="callback">The method to call when the connection has been established.</param>
<param name="proxyEndPoint">The IPEndPoint of the SOCKS proxy server.</param>
<returns>An IAsyncProxyResult that references the asynchronous connection.</returns>
</member>
<member name="P:Org.Mentalis.Network.ProxySocket.SocksHandler.Server">
<summary>
Gets or sets the socket connection with the proxy server.
</summary>
<value>A Socket object that represents the connection with the proxy server.</value>
<exception cref="T:System.ArgumentNullException">The specified value is null.</exception>
</member>
<member name="P:Org.Mentalis.Network.ProxySocket.SocksHandler.Username">
<summary>
Gets or sets the username to use when authenticating with the proxy server.
</summary>
<value>A string that holds the username to use when authenticating with the proxy server.</value>
<exception cref="T:System.ArgumentNullException">The specified value is null.</exception>
</member>
<member name="P:Org.Mentalis.Network.ProxySocket.SocksHandler.AsyncResult">
<summary>
Gets or sets the return value of the BeginConnect call.
</summary>
<value>An IAsyncProxyResult object that is the return value of the BeginConnect call.</value>
</member>
<member name="P:Org.Mentalis.Network.ProxySocket.SocksHandler.Buffer">
<summary>
Gets or sets a byte buffer.
</summary>
<value>An array of bytes.</value>
</member>
<member name="P:Org.Mentalis.Network.ProxySocket.SocksHandler.Received">
<summary>
Gets or sets the number of bytes that have been received from the remote proxy server.
</summary>
<value>An integer that holds the number of bytes that have been received from the remote proxy server.</value>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.Socks4Handler.#ctor(System.Net.Sockets.Socket,System.String)">
<summary>
Initilizes a new instance of the SocksHandler class.
</summary>
<param name="server">The socket connection with the proxy server.</param>
<param name="user">The username to use when authenticating with the server.</param>
<exception cref="T:System.ArgumentNullException"><c>server</c> -or- <c>user</c> is null.</exception>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.Socks4Handler.GetHostPortBytes(System.String,System.Int32)">
<summary>
Creates an array of bytes that has to be sent when the user wants to connect to a specific host/port combination.
</summary>
<param name="host">The host to connect to.</param>
<param name="port">The port to connect to.</param>
<returns>An array of bytes that has to be sent when the user wants to connect to a specific host/port combination.</returns>
<remarks>Resolving the host name will be done at server side. Do note that some SOCKS4 servers do not implement this functionality.</remarks>
<exception cref="T:System.ArgumentNullException"><c>host</c> is null.</exception>
<exception cref="T:System.ArgumentException"><c>port</c> is invalid.</exception>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.Socks4Handler.GetEndPointBytes(System.Net.IPEndPoint)">
<summary>
Creates an array of bytes that has to be sent when the user wants to connect to a specific IPEndPoint.
</summary>
<param name="remoteEP">The IPEndPoint to connect to.</param>
<returns>An array of bytes that has to be sent when the user wants to connect to a specific IPEndPoint.</returns>
<exception cref="T:System.ArgumentNullException"><c>remoteEP</c> is null.</exception>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.Socks4Handler.Negotiate(System.String,System.Int32)">
<summary>
Starts negotiating with the SOCKS server.
</summary>
<param name="host">The host to connect to.</param>
<param name="port">The port to connect to.</param>
<exception cref="T:System.ArgumentNullException"><c>host</c> is null.</exception>
<exception cref="T:System.ArgumentException"><c>port</c> is invalid.</exception>
<exception cref="T:Org.Mentalis.Network.ProxySocket.ProxyException">The proxy rejected the request.</exception>
<exception cref="T:System.Net.Sockets.SocketException">An operating system error occurs while accessing the Socket.</exception>
<exception cref="T:System.ObjectDisposedException">The Socket has been closed.</exception>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.Socks4Handler.Negotiate(System.Net.IPEndPoint)">
<summary>
Starts negotiating with the SOCKS server.
</summary>
<param name="remoteEP">The IPEndPoint to connect to.</param>
<exception cref="T:System.ArgumentNullException"><c>remoteEP</c> is null.</exception>
<exception cref="T:Org.Mentalis.Network.ProxySocket.ProxyException">The proxy rejected the request.</exception>
<exception cref="T:System.Net.Sockets.SocketException">An operating system error occurs while accessing the Socket.</exception>
<exception cref="T:System.ObjectDisposedException">The Socket has been closed.</exception>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.Socks4Handler.Negotiate(System.Byte[])">
<summary>
Starts negotiating with the SOCKS server.
</summary>
<param name="connect">The bytes to send when trying to authenticate.</param>
<exception cref="T:System.ArgumentNullException"><c>connect</c> is null.</exception>
<exception cref="T:System.ArgumentException"><c>connect</c> is too small.</exception>
<exception cref="T:Org.Mentalis.Network.ProxySocket.ProxyException">The proxy rejected the request.</exception>
<exception cref="T:System.Net.Sockets.SocketException">An operating system error occurs while accessing the Socket.</exception>
<exception cref="T:System.ObjectDisposedException">The Socket has been closed.</exception>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.Socks4Handler.BeginNegotiate(System.String,System.Int32,Org.Mentalis.Network.ProxySocket.HandShakeComplete,System.Net.IPEndPoint)">
<summary>
Starts negotiating asynchronously with a SOCKS proxy server.
</summary>
<param name="host">The remote server to connect to.</param>
<param name="port">The remote port to connect to.</param>
<param name="callback">The method to call when the connection has been established.</param>
<param name="proxyEndPoint">The IPEndPoint of the SOCKS proxy server.</param>
<returns>An IAsyncProxyResult that references the asynchronous connection.</returns>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.Socks4Handler.BeginNegotiate(System.Net.IPEndPoint,Org.Mentalis.Network.ProxySocket.HandShakeComplete,System.Net.IPEndPoint)">
<summary>
Starts negotiating asynchronously with a SOCKS proxy server.
</summary>
<param name="remoteEP">An IPEndPoint that represents the remote device.</param>
<param name="callback">The method to call when the connection has been established.</param>
<param name="proxyEndPoint">The IPEndPoint of the SOCKS proxy server.</param>
<returns>An IAsyncProxyResult that references the asynchronous connection.</returns>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.Socks4Handler.OnConnect(System.IAsyncResult)">
<summary>
Called when the Socket is connected to the remote proxy server.
</summary>
<param name="ar">Stores state information for this asynchronous operation as well as any user-defined data.</param>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.Socks4Handler.OnSent(System.IAsyncResult)">
<summary>
Called when the Socket has sent the handshake data.
</summary>
<param name="ar">Stores state information for this asynchronous operation as well as any user-defined data.</param>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.Socks4Handler.OnReceive(System.IAsyncResult)">
<summary>
Called when the Socket has received a reply from the remote proxy server.
</summary>
<param name="ar">Stores state information for this asynchronous operation as well as any user-defined data.</param>
</member>
<member name="T:Org.Mentalis.Network.ProxySocket.Socks5Handler">
<summary>
Implements the SOCKS5 protocol.
</summary>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.Socks5Handler.#ctor(System.Net.Sockets.Socket)">
<summary>
Initiliazes a new Socks5Handler instance.
</summary>
<param name="server">The socket connection with the proxy server.</param>
<exception cref="T:System.ArgumentNullException"><c>server</c> is null.</exception>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.Socks5Handler.#ctor(System.Net.Sockets.Socket,System.String)">
<summary>
Initiliazes a new Socks5Handler instance.
</summary>
<param name="server">The socket connection with the proxy server.</param>
<param name="user">The username to use.</param>
<exception cref="T:System.ArgumentNullException"><c>server</c> -or- <c>user</c> is null.</exception>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.Socks5Handler.#ctor(System.Net.Sockets.Socket,System.String,System.String)">
<summary>
Initiliazes a new Socks5Handler instance.
</summary>
<param name="server">The socket connection with the proxy server.</param>
<param name="user">The username to use.</param>
<param name="pass">The password to use.</param>
<exception cref="T:System.ArgumentNullException"><c>server</c> -or- <c>user</c> -or- <c>pass</c> is null.</exception>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.Socks5Handler.Authenticate">
<summary>
Starts the synchronous authentication process.
</summary>
<exception cref="T:Org.Mentalis.Network.ProxySocket.ProxyException">Authentication with the proxy server failed.</exception>
<exception cref="T:System.Net.ProtocolViolationException">The proxy server uses an invalid protocol.</exception>
<exception cref="T:System.Net.Sockets.SocketException">An operating system error occurs while accessing the Socket.</exception>
<exception cref="T:System.ObjectDisposedException">The Socket has been closed.</exception>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.Socks5Handler.GetHostPortBytes(System.String,System.Int32)">
<summary>
Creates an array of bytes that has to be sent when the user wants to connect to a specific host/port combination.
</summary>
<param name="host">The host to connect to.</param>
<param name="port">The port to connect to.</param>
<returns>An array of bytes that has to be sent when the user wants to connect to a specific host/port combination.</returns>
<exception cref="T:System.ArgumentNullException"><c>host</c> is null.</exception>
<exception cref="T:System.ArgumentException"><c>port</c> or <c>host</c> is invalid.</exception>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.Socks5Handler.GetEndPointBytes(System.Net.IPEndPoint)">
<summary>
Creates an array of bytes that has to be sent when the user wants to connect to a specific IPEndPoint.
</summary>
<param name="remoteEP">The IPEndPoint to connect to.</param>
<returns>An array of bytes that has to be sent when the user wants to connect to a specific IPEndPoint.</returns>
<exception cref="T:System.ArgumentNullException"><c>remoteEP</c> is null.</exception>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.Socks5Handler.Negotiate(System.String,System.Int32)">
<summary>
Starts negotiating with the SOCKS server.
</summary>
<param name="host">The host to connect to.</param>
<param name="port">The port to connect to.</param>
<exception cref="T:System.ArgumentNullException"><c>host</c> is null.</exception>
<exception cref="T:System.ArgumentException"><c>port</c> is invalid.</exception>
<exception cref="T:Org.Mentalis.Network.ProxySocket.ProxyException">The proxy rejected the request.</exception>
<exception cref="T:System.Net.Sockets.SocketException">An operating system error occurs while accessing the Socket.</exception>
<exception cref="T:System.ObjectDisposedException">The Socket has been closed.</exception>
<exception cref="T:System.Net.ProtocolViolationException">The proxy server uses an invalid protocol.</exception>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.Socks5Handler.Negotiate(System.Net.IPEndPoint)">
<summary>
Starts negotiating with the SOCKS server.
</summary>
<param name="remoteEP">The IPEndPoint to connect to.</param>
<exception cref="T:System.ArgumentNullException"><c>remoteEP</c> is null.</exception>
<exception cref="T:Org.Mentalis.Network.ProxySocket.ProxyException">The proxy rejected the request.</exception>
<exception cref="T:System.Net.Sockets.SocketException">An operating system error occurs while accessing the Socket.</exception>
<exception cref="T:System.ObjectDisposedException">The Socket has been closed.</exception>
<exception cref="T:System.Net.ProtocolViolationException">The proxy server uses an invalid protocol.</exception>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.Socks5Handler.Negotiate(System.Byte[])">
<summary>
Starts negotiating with the SOCKS server.
</summary>
<param name="connect">The bytes to send when trying to authenticate.</param>
<exception cref="T:System.ArgumentNullException"><c>connect</c> is null.</exception>
<exception cref="T:System.ArgumentException"><c>connect</c> is too small.</exception>
<exception cref="T:Org.Mentalis.Network.ProxySocket.ProxyException">The proxy rejected the request.</exception>
<exception cref="T:System.Net.Sockets.SocketException">An operating system error occurs while accessing the Socket.</exception>
<exception cref="T:System.ObjectDisposedException">The Socket has been closed.</exception>
<exception cref="T:System.Net.ProtocolViolationException">The proxy server uses an invalid protocol.</exception>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.Socks5Handler.BeginNegotiate(System.String,System.Int32,Org.Mentalis.Network.ProxySocket.HandShakeComplete,System.Net.IPEndPoint)">
<summary>
Starts negotiating asynchronously with the SOCKS server.
</summary>
<param name="host">The host to connect to.</param>
<param name="port">The port to connect to.</param>
<param name="callback">The method to call when the negotiation is complete.</param>
<param name="proxyEndPoint">The IPEndPoint of the SOCKS proxy server.</param>
<returns>An IAsyncProxyResult that references the asynchronous connection.</returns>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.Socks5Handler.BeginNegotiate(System.Net.IPEndPoint,Org.Mentalis.Network.ProxySocket.HandShakeComplete,System.Net.IPEndPoint)">
<summary>
Starts negotiating asynchronously with the SOCKS server.
</summary>
<param name="remoteEP">An IPEndPoint that represents the remote device.</param>
<param name="callback">The method to call when the negotiation is complete.</param>
<param name="proxyEndPoint">The IPEndPoint of the SOCKS proxy server.</param>
<returns>An IAsyncProxyResult that references the asynchronous connection.</returns>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.Socks5Handler.OnConnect(System.IAsyncResult)">
<summary>
Called when the socket is connected to the remote server.
</summary>
<param name="ar">Stores state information for this asynchronous operation as well as any user-defined data.</param>
</member>
<member name="M:Org.Mentalis.Network.ProxySocket.Socks5Handler.OnAuthSent(System.IAsyncResult)">
<summary>
Called when the authentication bytes have been sent.