mcs/class/System/Documentation/en/System.Net/EndPoint.xml

   1 <Type Name="EndPoint" FullName="System.Net.EndPoint" FullNameSP="System_Net_EndPoint" Maintainer="ecma">
   2   <TypeSignature Language="ILASM" Value=".class public abstract serializable EndPoint extends System.Object" />
   3   <TypeSignature Language="C#" Value="public abstract class EndPoint" />
   4   <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract serializable beforefieldinit EndPoint extends System.Object" />
   5   <MemberOfLibrary>Networking</MemberOfLibrary>
   6   <AssemblyInfo>
   7     <AssemblyName>System</AssemblyName>
   8     <AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00 ]</AssemblyPublicKey>
   9     <AssemblyVersion>1.0.x.x</AssemblyVersion>
  10     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  11     <AssemblyVersion>2.0.0.0</AssemblyVersion>
  12     <AssemblyVersion>4.0.0.0</AssemblyVersion>
  13   </AssemblyInfo>
  14   <ThreadingSafetyStatement>All public static members of this type are safe for multithreaded operations. No instance members are guaranteed to be thread safe.</ThreadingSafetyStatement>
  15   <Base>
  16     <BaseTypeName>System.Object</BaseTypeName>
  17   </Base>
  18   <Interfaces />
  19   <Docs>
  20     <summary>
  21       <para> This is the base class used to derive classes that
  22  represent network addresses.
  23  </para>
  24     </summary>
  25     <remarks>
  26       <para>
  27         <block subset="none" type="note">The <see cref="T:System.Net.EndPoint" /> class provides an
  28  abstract representation of the address of a network resource or
  29  service. </block>
  30       </para>
  31     </remarks>
  32   </Docs>
  33   <Members>
  34     <Member MemberName=".ctor">
  35       <MemberSignature Language="ILASM" Value="family specialname instance void .ctor()" />
  36       <MemberSignature Language="C#" Value="protected EndPoint ();" />
  37       <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
  38       <MemberType>Constructor</MemberType>
  39       <AssemblyInfo>
  40         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  41         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  42         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  43       </AssemblyInfo>
  44       <ReturnValue />
  45       <Parameters />
  46       <Docs>
  47         <summary>Constructs a new instance of the <see cref="T:System.Net.EndPoint" /> class.</summary>
  48         <remarks>To be added.</remarks>
  49       </Docs>
  50       <Excluded>0</Excluded>
  51     </Member>
  52     <Member MemberName="AddressFamily">
  53       <MemberSignature Language="ILASM" Value=".property valuetype System.Net.Sockets.AddressFamily AddressFamily { public hidebysig virtual specialname valuetype System.Net.Sockets.AddressFamily get_AddressFamily() }" />
  54       <MemberSignature Language="C#" Value="public virtual System.Net.Sockets.AddressFamily AddressFamily { get; }" />
  55       <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Net.Sockets.AddressFamily AddressFamily" />
  56       <MemberType>Property</MemberType>
  57       <AssemblyInfo>
  58         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  59         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  60         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  61       </AssemblyInfo>
  62       <ReturnValue>
  63         <ReturnType>System.Net.Sockets.AddressFamily</ReturnType>
  64       </ReturnValue>
  65       <Parameters />
  66       <Docs>
  67         <summary>
  68           <para> Gets the address family to which the endpoint belongs.
  69       </para>
  70         </summary>
  71         <value>
  72           <para>One of the values defined in <see cref="T:System.Net.Sockets.AddressFamily" /> .</para>
  73         </value>
  74         <remarks>
  75           <block subset="none" type="behaviors">
  76             <para>This property is read-only.</para>
  77             <para>The <see cref="T:System.Net.Sockets.AddressFamily" /> value returned
  78       by this property specifies the addressing scheme used
  79       by the network protocol of the current instance. </para>
  80           </block>
  81           <para>
  82             <block subset="none" type="default">The default implementation throws <see cref="T:System.NotSupportedException" />. </block>
  83           </para>
  84           <para>
  85             <block subset="none" type="overrides">Override this
  86    property to return the <see cref="T:System.Net.Sockets.AddressFamily" />
  87    of the current instance.</block>
  88           </para>
  89           <para>
  90             <block subset="none" type="usage">Use this property to
  91    obtain the <see cref="T:System.Net.Sockets.AddressFamily" /> information of the current instance.
  92 </block>
  93           </para>
  94         </remarks>
  95         <exception cref="T:System.NotSupportedException">This property is required to be overridden in types derived from <see cref="T:System.Net.EndPoint" /> .</exception>
  96       </Docs>
  97       <Excluded>0</Excluded>
  98     </Member>
  99     <Member MemberName="Create">
 100       <MemberSignature Language="ILASM" Value=".method public hidebysig virtual class System.Net.EndPoint Create(class System.Net.SocketAddress socketAddress)" />
 101       <MemberSignature Language="C#" Value="public virtual System.Net.EndPoint Create (System.Net.SocketAddress socketAddress);" />
 102       <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Net.EndPoint Create(class System.Net.SocketAddress socketAddress) cil managed" />
 103       <MemberType>Method</MemberType>
 104       <AssemblyInfo>
 105         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 106         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 107         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 108       </AssemblyInfo>
 109       <ReturnValue>
 110         <ReturnType>System.Net.EndPoint</ReturnType>
 111       </ReturnValue>
 112       <Parameters>
 113         <Parameter Name="socketAddress" Type="System.Net.SocketAddress" />
 114       </Parameters>
 115       <Docs>
 116         <param name="socketAddress">A <see cref="T:System.Net.SocketAddress" /> instance that provides the address information for the new <see cref="T:System.Net.EndPoint" /> instance.</param>
 117         <summary>
 118           <para> Returns a new <see cref="T:System.Net.EndPoint" /> instance containing the address
 119    information from the specified <see cref="T:System.Net.SocketAddress" />
 120    instance.
 121    </para>
 122         </summary>
 123         <returns>
 124           <para>A new <see cref="T:System.Net.EndPoint" /> instance containing the address
 125    information from the specified <see cref="T:System.Net.SocketAddress" /> instance.</para>
 126         </returns>
 127         <remarks>
 128           <para>
 129             <block subset="none" type="behaviors"> As described above.</block>
 130           </para>
 131           <para>
 132             <block subset="none" type="default">The default implementation throws
 133    <see cref="T:System.NotSupportedException" />. </block>
 134           </para>
 135           <para>
 136             <block subset="none" type="overrides">Override this
 137       method to return a <see cref="T:System.Net.EndPoint" /> instance that contains the address information from
 138       the specified <see cref="T:System.Net.SocketAddress" />.</block>
 139           </para>
 140           <para>
 141             <block subset="none" type="usage">Use this method to
 142       obtain a <see cref="T:System.Net.EndPoint" />
 143       instance that represents the same network resource or service as the specified
 144    <see cref="T:System.Net.SocketAddress" />. </block>
 145           </para>
 146         </remarks>
 147         <exception cref="T:System.NotSupportedException">This method is required to be overridden in types derived from <see cref="T:System.Net.EndPoint" /> .</exception>
 148       </Docs>
 149       <Excluded>0</Excluded>
 150     </Member>
 151     <Member MemberName="Serialize">
 152       <MemberSignature Language="C#" Value="public virtual System.Net.SocketAddress Serialize ();" />
 153       <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Net.SocketAddress Serialize() cil managed" />
 154       <MemberType>Method</MemberType>
 155       <AssemblyInfo>
 156         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 157         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 158         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 159       </AssemblyInfo>
 160       <ReturnValue>
 161         <ReturnType>System.Net.SocketAddress</ReturnType>
 162       </ReturnValue>
 163       <Parameters />
 164       <Docs>
 165         <summary>To be added.</summary>
 166         <returns>To be added.</returns>
 167         <remarks>To be added.</remarks>
 168       </Docs>
 169     </Member>
 170   </Members>
 171   <TypeExcluded>0</TypeExcluded>
 172 </Type>