File: MulticastOption.xml

package info (click to toggle)
monodoc 1.1.18-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 58,432 kB
  • ctags: 4,991
  • sloc: xml: 718,392; cs: 38,337; sh: 3,172; perl: 554; makefile: 303
file content (157 lines) | stat: -rwxr-xr-x 8,070 bytes parent folder | download
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
<Type Name="MulticastOption" FullName="System.Net.Sockets.MulticastOption" FullNameSP="System_Net_Sockets_MulticastOption" Maintainer="ecma">
  <TypeSignature Language="ILASM" Value=".class public MulticastOption extends System.Object" />
  <TypeSignature Language="C#" Value="public class MulticastOption" />
  <MemberOfLibrary>Networking</MemberOfLibrary>
  <AssemblyInfo>
    <AssemblyName>System</AssemblyName>
    <AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00 ]</AssemblyPublicKey>
    <AssemblyVersion>1.0.x.x</AssemblyVersion>
    <AssemblyCulture>none</AssemblyCulture>
    <Attributes>
      <Attribute>
        <AttributeName>CLSCompliantAttribute(true)</AttributeName>
        <Excluded>0</Excluded>
      </Attribute>
    </Attributes>
  </AssemblyInfo>
  <ThreadingSafetyStatement>All public static members of this type are safe for multithreaded operations. No instance members are guaranteed to be thread safe.</ThreadingSafetyStatement>
  <Docs>
    <summary>
      <para> Contains Internet Protocol (IP) addresses used
      when joining or leaving
      an IP multicast group.</para>
    </summary>
    <remarks>
      <para>Collectively, the hosts listening to a specific IP multicast address (the group address) are
      called a multicast group. Each member of the group receives any IP messages sent
      to the group address. </para>
      <para> An instance of this class is passed into the <see cref="M:System.Net.Sockets.Socket.SetSocketOption(System.Net.Sockets.SocketOptionLevel,System.Net.Sockets.SocketOptionName,System.Int32)" qualify="true" /> method
   and returned by the <see cref="M:System.Net.Sockets.Socket.GetSocketOption(System.Net.Sockets.SocketOptionLevel,System.Net.Sockets.SocketOptionName)" qualify="true" /> method when the <paramref name="optionName" />
   parameter is set to <see cref="F:System.Net.Sockets.SocketOptionName.AddMembership" qualify="true" /> or <see cref="F:System.Net.Sockets.SocketOptionName.DropMembership" qualify="true" />. </para>
    </remarks>
  </Docs>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="ILASM" Value="public rtspecialname specialname instance void .ctor(class System.Net.IPAddress group, class System.Net.IPAddress mcint)" />
      <MemberSignature Language="C#" Value="public MulticastOption(IPAddress group, IPAddress mcint);" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters>
		<Parameter Name="group" Type="System.Net.IPAddress" />
		<Parameter Name="mcint" Type="System.Net.IPAddress" />
	</Parameters>
      <Docs>
        <summary>
          <para>Constructs and initializes a new instance of the <see cref="T:System.Net.Sockets.MulticastOption" /> class with the specified IP
   multicast group and local addresses.</para>
        </summary>
        <param name="group"> An instance of <see cref="T:System.Net.IPAddress" qualify="true" /> containing the group IP address.</param>
        <param name=" mcint"> An instance of <see cref="T:System.Net.IPAddress" qualify="true" /> containing the local IP address.</param>
        <exception cref="T:System.ArgumentNullException">
          <para>
            <paramref name="group " /> or <paramref name="mcint" /> is <see langword="null" />.</para>
        </exception>
        <remarks>
          <para>The <see cref="P:System.Net.Sockets.MulticastOption.Group" /> property is set to <paramref name="group" /> and the
<see cref="P:System.Net.Sockets.MulticastOption.LocalAddress" /> property is set to <paramref name="mcint" />.</para>
        </remarks>
      </Docs>
      <Excluded>0</Excluded>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="ILASM" Value="public rtspecialname specialname instance void .ctor(class System.Net.IPAddress group)" />
      <MemberSignature Language="C#" Value="public MulticastOption(IPAddress group);" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters>
		<Parameter Name="group" Type="System.Net.IPAddress" />
	</Parameters>
      <Docs>
        <summary>
          <para>Constructs and initializes a new instance of the <see cref="T:System.Net.Sockets.MulticastOption" /> class with the specified IP multicast group
   address.</para>
        </summary>
        <param name="group">An instance of <see cref="T:System.Net.IPAddress" qualify="true" /> containing the IP address of a multicast group.</param>
        <exception cref="T:System.ArgumentNullException">
          <para>
            <paramref name="group " />is <see langword="null" />.</para>
        </exception>
        <remarks>
          <para>This constructor initializes the <see cref="P:System.Net.Sockets.MulticastOption.Group" /> property of the new instance using
<paramref name="group" />. The <see cref="P:System.Net.Sockets.MulticastOption.LocalAddress" /> property is initialized to <see cref="F:System.Net.IPAddress.Any" qualify="true" />. <see langword="Any" /> 
allows the protocol to decide which local IP address to
use.</para>
        </remarks>
      </Docs>
      <Excluded>0</Excluded>
    </Member>
    <Member MemberName="Group">
      <MemberSignature Language="ILASM" Value=".property class System.Net.IPAddress Group { public hidebysig specialname instance class System.Net.IPAddress get_Group() public hidebysig specialname instance void set_Group(class System.Net.IPAddress value) }" />
      <MemberSignature Language="C#" Value="public IPAddress Group { get; set; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Net.IPAddress</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
          <para> Gets or sets the IP address of a multicast group.</para>
        </summary>
        <value>
          <para> An instance of <see cref="T:System.Net.IPAddress" qualify="true" />
containing the IP address of a multicast
group.</para>
        </value>
        <remarks>
          <para> Collectively, the hosts listening to a specific IP
      multicast address are called a multicast group. Each member of the group receives any IP messages sent to this
      address. </para>
          <block subset="none" type="note">
            <para>Valid IP addresses for multicast groups are in the range 224.0.0.0 to
         239.255.255.255 with some addresses reserved for special purposes. </para>
          </block>
        </remarks>
      </Docs>
      <Excluded>0</Excluded>
    </Member>
    <Member MemberName="LocalAddress">
      <MemberSignature Language="ILASM" Value=".property class System.Net.IPAddress LocalAddress { public hidebysig specialname instance class System.Net.IPAddress get_LocalAddress() public hidebysig specialname instance void set_LocalAddress(class System.Net.IPAddress value) }" />
      <MemberSignature Language="C#" Value="public IPAddress LocalAddress { get; set; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Net.IPAddress</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
          <para> Gets or sets the local IP address to receive data.</para>
        </summary>
        <value>
          <para> An instance of <see cref="T:System.Net.IPAddress" qualify="true" /> containing the local IP
   address.</para>
        </value>
        <remarks>
          <para>This property specifies the local IP address used to receive data
      sent to the multicast group. </para>
        </remarks>
      </Docs>
      <Excluded>0</Excluded>
    </Member>
  <Member MemberName="local">
      <MemberSignature Language="C#" Value="protected System.Net.IPAddress local" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>System.Net.IPAddress</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
  <TypeExcluded>0</TypeExcluded>
</Type>