mcs/class/Mono.Posix/Documentation/en/Mono.Unix/UnixEndPoint.xml

   1 <Type Name="UnixEndPoint" FullName="Mono.Unix.UnixEndPoint">
   2   <TypeSignature Language="C#" Value="public class UnixEndPoint : System.Net.EndPoint" />
   3   <AssemblyInfo>
   4     <AssemblyName>Mono.Posix</AssemblyName>
   5     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
   6     <AssemblyVersion>2.0.0.0</AssemblyVersion>
   7   </AssemblyInfo>
   8   <Base>
   9     <BaseTypeName>System.Net.EndPoint</BaseTypeName>
  10   </Base>
  11   <Interfaces />
  12   <Docs>
  13     <summary>A <see cref="T:System.Net.EndPoint" /> implementation for UNIX sockets as network addresses.</summary>
  14     <remarks>
  15       <example>
  16         <code lang="C#">
  17 try
  18 {
  19         UnixEndPoint endPoint = new UnixEndPoint (socketName);
  20         socket.Connect (endPoint);
  21         stream = new NetworkStream (socket, true);
  22         return true;
  23 }
  24 catch (Exception ex)
  25 {
  26         baseException = ex;
  27         return false;
  28 }</code>
  29       </example>
  30     </remarks>
  31   </Docs>
  32   <Members>
  33     <Member MemberName=".ctor">
  34       <MemberSignature Language="C#" Value="public UnixEndPoint (string filename);" />
  35       <MemberType>Constructor</MemberType>
  36       <Parameters>
  37         <Parameter Name="filename" Type="System.String" />
  38       </Parameters>
  39       <Docs>
  40         <param name="filename">a <see cref="T:System.String" /> representing the socket name.</param>
  41         <summary>Constructor with socketName as parameter.</summary>
  42         <remarks />
  43       </Docs>
  44       <AssemblyInfo>
  45         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  46         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  47       </AssemblyInfo>
  48     </Member>
  49     <Member MemberName="AddressFamily">
  50       <MemberSignature Language="C#" Value="public override System.Net.Sockets.AddressFamily AddressFamily { get; }" />
  51       <MemberType>Property</MemberType>
  52       <ReturnValue>
  53         <ReturnType>System.Net.Sockets.AddressFamily</ReturnType>
  54       </ReturnValue>
  55       <Docs>
  56         <summary>To be added.</summary>
  57         <value>To be added.</value>
  58         <remarks>To be added.</remarks>
  59       </Docs>
  60       <AssemblyInfo>
  61         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  62         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  63       </AssemblyInfo>
  64     </Member>
  65     <Member MemberName="Create">
  66       <MemberSignature Language="C#" Value="public override System.Net.EndPoint Create (System.Net.SocketAddress socketAddress);" />
  67       <MemberType>Method</MemberType>
  68       <ReturnValue>
  69         <ReturnType>System.Net.EndPoint</ReturnType>
  70       </ReturnValue>
  71       <Parameters>
  72         <Parameter Name="socketAddress" Type="System.Net.SocketAddress" />
  73       </Parameters>
  74       <Docs>
  75         <param name="socketAddress">To be added.</param>
  76         <summary>To be added.</summary>
  77         <returns>To be added.</returns>
  78         <remarks>To be added.</remarks>
  79       </Docs>
  80       <AssemblyInfo>
  81         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  82         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  83       </AssemblyInfo>
  84     </Member>
  85     <Member MemberName="Equals">
  86       <MemberSignature Language="C#" Value="public override bool Equals (object o);" />
  87       <MemberType>Method</MemberType>
  88       <ReturnValue>
  89         <ReturnType>System.Boolean</ReturnType>
  90       </ReturnValue>
  91       <Parameters>
  92         <Parameter Name="o" Type="System.Object" />
  93       </Parameters>
  94       <Docs>
  95         <param name="o">To be added.</param>
  96         <summary>To be added.</summary>
  97         <returns>To be added.</returns>
  98         <remarks>To be added.</remarks>
  99       </Docs>
 100       <AssemblyInfo>
 101         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 102         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 103       </AssemblyInfo>
 104     </Member>
 105     <Member MemberName="Filename">
 106       <MemberSignature Language="C#" Value="public string Filename { set; get; }" />
 107       <MemberType>Property</MemberType>
 108       <ReturnValue>
 109         <ReturnType>System.String</ReturnType>
 110       </ReturnValue>
 111       <Docs>
 112         <summary>Returns the filename representing the unix socket.</summary>
 113         <value>a <see cref="T:System.String" /></value>
 114         <remarks />
 115       </Docs>
 116       <AssemblyInfo>
 117         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 118         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 119       </AssemblyInfo>
 120     </Member>
 121     <Member MemberName="GetHashCode">
 122       <MemberSignature Language="C#" Value="public override int GetHashCode ();" />
 123       <MemberType>Method</MemberType>
 124       <ReturnValue>
 125         <ReturnType>System.Int32</ReturnType>
 126       </ReturnValue>
 127       <Parameters />
 128       <Docs>
 129         <summary>To be added.</summary>
 130         <returns>To be added.</returns>
 131         <remarks>To be added.</remarks>
 132       </Docs>
 133       <AssemblyInfo>
 134         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 135         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 136       </AssemblyInfo>
 137     </Member>
 138     <Member MemberName="Serialize">
 139       <MemberSignature Language="C#" Value="public override System.Net.SocketAddress Serialize ();" />
 140       <MemberType>Method</MemberType>
 141       <ReturnValue>
 142         <ReturnType>System.Net.SocketAddress</ReturnType>
 143       </ReturnValue>
 144       <Parameters />
 145       <Docs>
 146         <summary>To be added.</summary>
 147         <returns>To be added.</returns>
 148         <remarks>To be added.</remarks>
 149       </Docs>
 150       <AssemblyInfo>
 151         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 152         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 153       </AssemblyInfo>
 154     </Member>
 155     <Member MemberName="ToString">
 156       <MemberSignature Language="C#" Value="public override string ToString ();" />
 157       <MemberType>Method</MemberType>
 158       <ReturnValue>
 159         <ReturnType>System.String</ReturnType>
 160       </ReturnValue>
 161       <Parameters />
 162       <Docs>
 163         <summary>To be added.</summary>
 164         <returns>To be added.</returns>
 165         <remarks>To be added.</remarks>
 166       </Docs>
 167       <AssemblyInfo>
 168         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 169         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 170       </AssemblyInfo>
 171     </Member>
 172   </Members>
 173 </Type>