Merge pull request #409 from Alkarex/patch-1
[mono.git] / mcs / class / Mono.Posix / Documentation / en / Mono.Posix / UnixEndPoint.xml
1 <Type Name="UnixEndPoint" FullName="Mono.Posix.UnixEndPoint">
2   <TypeSignature Language="C#" Value="public class UnixEndPoint : System.Net.EndPoint" Maintainer="auto" />
3   <TypeSignature Language="ILAsm" Value=".class public auto ansi serializable beforefieldinit UnixEndPoint extends System.Net.EndPoint" />
4   <AssemblyInfo>
5     <AssemblyName>Mono.Posix</AssemblyName>
6     <AssemblyPublicKey>[00 24 00 00 04 80 00 00 94 00 00 00 06 02 00 00 00 24 00 00 52 53 41 31 00 04 00 00 01 00 01 00 79 15 99 77 D2 D0 3A 8E 6B EA 7A 2E 74 E8 D1 AF CC 93 E8 85 19 74 95 2B B4 80 A1 2C 91 34 47 4D 04 06 24 47 C3 7E 0E 68 C0 80 53 6F CF 3C 3F BE 2F F9 C9 79 CE 99 84 75 E5 06 E8 CE 82 DD 5B 0F 35 0D C1 0E 93 BF 2E EE CF 87 4B 24 77 0C 50 81 DB EA 74 47 FD DA FA 27 7B 22 DE 47 D6 FF EA 44 96 74 A4 F9 FC CF 84 D1 50 69 08 93 80 28 4D BD D3 5F 46 CD FF 12 A1 BD 78 E4 EF 00 65 D0 16 DF]</AssemblyPublicKey>
7     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
8     <AssemblyVersion>2.0.0.0</AssemblyVersion>
9     <AssemblyVersion>4.0.0.0</AssemblyVersion>
10   </AssemblyInfo>
11   <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
12   <Base>
13     <BaseTypeName>System.Net.EndPoint</BaseTypeName>
14   </Base>
15   <Interfaces />
16   <Attributes>
17     <Attribute>
18       <AttributeName>System.Obsolete("Use Mono.Unix.UnixEndPoint")</AttributeName>
19     </Attribute>
20   </Attributes>
21   <Docs>
22     <summary>A System.Net.EndPoint implementation for UNIX sockets as network addresses..</summary>
23     <remarks>
24       <para>This type is obsolete.  Please use 
25       <see cref="T:Mono.Unix.UnixEndPoint" /> instead.</para>
26       <example>
27         <code lang="C#">
28 try
29 {
30         UnixEndPoint endPoint = new UnixEndPoint (socketName);
31         socket.Connect (endPoint);
32         stream = new NetworkStream (socket, true);
33         return true;
34 }
35 catch (Exception ex)
36 {
37         baseException = ex;
38         return false;
39 }
40   </code>
41       </example>
42     </remarks>
43     <altmember cref="T:Mono.Unix.UnixEndPoint" />
44   </Docs>
45   <Members>
46     <Member MemberName=".ctor">
47       <MemberSignature Language="C#" Value="public UnixEndPoint (string filename);" />
48       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string filename) cil managed" />
49       <MemberType>Constructor</MemberType>
50       <AssemblyInfo>
51         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
52         <AssemblyVersion>2.0.0.0</AssemblyVersion>
53         <AssemblyVersion>4.0.0.0</AssemblyVersion>
54       </AssemblyInfo>
55       <ReturnValue />
56       <Parameters>
57         <Parameter Name="filename" Type="System.String" />
58       </Parameters>
59       <Docs>
60         <param name="filename">a <see cref="T:System.String" /> representing the socket name.</param>
61         <summary>Constructor with socketName as parameter.</summary>
62         <remarks />
63         <altmember cref="C:Mono.Unix.UnixEndPoint(System.String)" />
64       </Docs>
65     </Member>
66     <Member MemberName="AddressFamily">
67       <MemberSignature Language="C#" Value="public override System.Net.Sockets.AddressFamily AddressFamily { get; }" />
68       <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Net.Sockets.AddressFamily AddressFamily" />
69       <MemberType>Property</MemberType>
70       <AssemblyInfo>
71         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
72         <AssemblyVersion>2.0.0.0</AssemblyVersion>
73         <AssemblyVersion>4.0.0.0</AssemblyVersion>
74       </AssemblyInfo>
75       <ReturnValue>
76         <ReturnType>System.Net.Sockets.AddressFamily</ReturnType>
77       </ReturnValue>
78       <Docs>
79         <summary>To be added.</summary>
80         <value>To be added.</value>
81         <remarks>To be added.</remarks>
82       </Docs>
83     </Member>
84     <Member MemberName="Create">
85       <MemberSignature Language="C#" Value="public override System.Net.EndPoint Create (System.Net.SocketAddress socketAddress);" />
86       <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.Net.EndPoint Create(class System.Net.SocketAddress socketAddress) cil managed" />
87       <MemberType>Method</MemberType>
88       <AssemblyInfo>
89         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
90         <AssemblyVersion>2.0.0.0</AssemblyVersion>
91         <AssemblyVersion>4.0.0.0</AssemblyVersion>
92       </AssemblyInfo>
93       <ReturnValue>
94         <ReturnType>System.Net.EndPoint</ReturnType>
95       </ReturnValue>
96       <Parameters>
97         <Parameter Name="socketAddress" Type="System.Net.SocketAddress" />
98       </Parameters>
99       <Docs>
100         <param name="socketAddress">To be added.</param>
101         <summary>To be added.</summary>
102         <returns>To be added.</returns>
103         <remarks>To be added.</remarks>
104       </Docs>
105     </Member>
106     <Member MemberName="Equals">
107       <MemberSignature Language="C#" Value="public override bool Equals (object o);" />
108       <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object o) cil managed" />
109       <MemberType>Method</MemberType>
110       <AssemblyInfo>
111         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
112         <AssemblyVersion>2.0.0.0</AssemblyVersion>
113         <AssemblyVersion>4.0.0.0</AssemblyVersion>
114       </AssemblyInfo>
115       <ReturnValue>
116         <ReturnType>System.Boolean</ReturnType>
117       </ReturnValue>
118       <Parameters>
119         <Parameter Name="o" Type="System.Object" />
120       </Parameters>
121       <Docs>
122         <param name="o">To be added.</param>
123         <summary>To be added.</summary>
124         <returns>To be added.</returns>
125         <remarks>To be added.</remarks>
126       </Docs>
127     </Member>
128     <Member MemberName="Filename">
129       <MemberSignature Language="C#" Value="public string Filename { get; set; }" />
130       <MemberSignature Language="ILAsm" Value=".property instance string Filename" />
131       <MemberType>Property</MemberType>
132       <AssemblyInfo>
133         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
134         <AssemblyVersion>2.0.0.0</AssemblyVersion>
135         <AssemblyVersion>4.0.0.0</AssemblyVersion>
136       </AssemblyInfo>
137       <ReturnValue>
138         <ReturnType>System.String</ReturnType>
139       </ReturnValue>
140       <Parameters />
141       <Docs>
142         <summary>Returns the filename representing the unix socket.</summary>
143         <value>a <see cref="T:System.String" /></value>
144         <remarks />
145         <altmember cref="P:Mono.Unix.UnixEndPoint.Filename" />
146       </Docs>
147     </Member>
148     <Member MemberName="GetHashCode">
149       <MemberSignature Language="C#" Value="public override int GetHashCode ();" />
150       <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" />
151       <MemberType>Method</MemberType>
152       <AssemblyInfo>
153         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
154         <AssemblyVersion>2.0.0.0</AssemblyVersion>
155         <AssemblyVersion>4.0.0.0</AssemblyVersion>
156       </AssemblyInfo>
157       <ReturnValue>
158         <ReturnType>System.Int32</ReturnType>
159       </ReturnValue>
160       <Parameters />
161       <Docs>
162         <summary>To be added.</summary>
163         <returns>To be added.</returns>
164         <remarks>To be added.</remarks>
165       </Docs>
166     </Member>
167     <Member MemberName="Serialize">
168       <MemberSignature Language="C#" Value="public override System.Net.SocketAddress Serialize ();" />
169       <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.Net.SocketAddress Serialize() cil managed" />
170       <MemberType>Method</MemberType>
171       <AssemblyInfo>
172         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
173         <AssemblyVersion>2.0.0.0</AssemblyVersion>
174         <AssemblyVersion>4.0.0.0</AssemblyVersion>
175       </AssemblyInfo>
176       <ReturnValue>
177         <ReturnType>System.Net.SocketAddress</ReturnType>
178       </ReturnValue>
179       <Parameters />
180       <Docs>
181         <summary>To be added.</summary>
182         <returns>To be added.</returns>
183         <remarks>To be added.</remarks>
184       </Docs>
185     </Member>
186     <Member MemberName="ToString">
187       <MemberSignature Language="C#" Value="public override string ToString ();" />
188       <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
189       <MemberType>Method</MemberType>
190       <AssemblyInfo>
191         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
192         <AssemblyVersion>2.0.0.0</AssemblyVersion>
193         <AssemblyVersion>4.0.0.0</AssemblyVersion>
194       </AssemblyInfo>
195       <ReturnValue>
196         <ReturnType>System.String</ReturnType>
197       </ReturnValue>
198       <Parameters />
199       <Docs>
200         <summary>To be added.</summary>
201         <returns>To be added.</returns>
202         <remarks>To be added.</remarks>
203       </Docs>
204     </Member>
205   </Members>
206 </Type>