|
<?xml version="1.0"?>
<doc>
<assembly>
<name>/home/cmorgan/packetnet_git/PacketDotNet/bin/Release/PacketDotNet</name>
</assembly>
<members>
<member name="T:PacketDotNet.ApplicationPacket">
<summary>
Represents an application layer packet as described at http://en.wikipedia.org/wiki/Application_Layer
</summary>
</member>
<member name="M:PacketDotNet.ApplicationPacket.#ctor">
<summary>
ApplicationPacket constructor
</summary>
</member>
<member name="T:PacketDotNet.DataLinkPacket">
<summary>
Represents a Layer 2 protocol.
</summary>
</member>
<member name="M:PacketDotNet.DataLinkPacket.#ctor">
<summary>
DataLinkPacket constructor
</summary>
</member>
<member name="T:PacketDotNet.EthernetPacket">
<summary>
See http://en.wikipedia.org/wiki/Ethernet#Ethernet_frame_types_and_the_EtherType_field
</summary>
</member>
<member name="M:PacketDotNet.EthernetPacket.#ctor(System.Net.NetworkInformation.PhysicalAddress,System.Net.NetworkInformation.PhysicalAddress,PacketDotNet.EthernetPacketType)">
<summary>
Construct a new ethernet packet from source and destination mac addresses
</summary>
</member>
<member name="M:PacketDotNet.EthernetPacket.#ctor(PacketDotNet.Utils.ByteArraySegment)">
<summary>
Constructor
</summary>
<param name="bas">
A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
</member>
<member name="P:PacketDotNet.EthernetPacket.PayloadPacket">
<value>
Payload packet, overridden to set the 'Type' field based on
the type of packet being used here if the PayloadPacket is being set
</value>
</member>
<member name="P:PacketDotNet.EthernetPacket.SourceHwAddress">
<summary> MAC address of the host where the packet originated from.</summary>
</member>
<member name="P:PacketDotNet.EthernetPacket.DestinationHwAddress">
<summary> MAC address of the host where the packet originated from.</summary>
</member>
<member name="P:PacketDotNet.EthernetPacket.Type">
<value>
Type of packet that this ethernet packet encapsulates
</value>
</member>
<member name="P:PacketDotNet.EthernetPacket.Color">
<summary> Fetch ascii escape sequence of the color associated with this packet type.</summary>
</member>
<member name="M:PacketDotNet.EthernetPacket.ParseEncapsulatedBytes(PacketDotNet.Utils.ByteArraySegment,PacketDotNet.EthernetPacketType)">
<summary>
Used by the EthernetPacket constructor. Located here because the LinuxSLL constructor
also needs to perform the same operations as it contains an ethernet type
</summary>
<param name="Header">
A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
<param name="Type">
A <see cref="T:PacketDotNet.EthernetPacketType" /></param>
<returns>
A <see cref="T:PacketDotNet.PacketOrByteArraySegment" /></returns>
</member>
<member name="M:PacketDotNet.EthernetPacket.GetEncapsulated(PacketDotNet.Packet)">
<summary>
Returns the EthernetPacket inside of the Packet p or null if
there is no encapsulated packet
</summary>
<param name="p">
A <see cref="T:PacketDotNet.Packet" /></param>
<returns>
A <see cref="T:PacketDotNet.EthernetPacket" /></returns>
</member>
<member name="M:PacketDotNet.EthernetPacket.ToString(PacketDotNet.StringOutputType)">
<summary cref="Packet.ToString(StringOutputType)" />
</member>
<member name="M:PacketDotNet.EthernetPacket.RandomPacket">
<summary>
Generate a random EthernetPacket
TODO: could improve this routine to set a random payload as well
</summary>
<returns>
A <see cref="T:PacketDotNet.EthernetPacket" /></returns>
</member>
<member name="T:PacketDotNet.EthernetPacketType">
Copied from Pcap.Net @ 20091117
<summary>
Code constants for well-defined ethernet protocols.
EtherType is a two-octet field in an Ethernet frame, as defined by the Ethernet II framing networking standard.
It is used to indicate which protocol is encapsulated in the payload.
Also contains entries taken from linux/if_ether.h and tcpdump/ethertype.h
</summary></member>
<member name="F:PacketDotNet.EthernetPacketType.None">
<summary>
No Ethernet type
</summary>
</member>
<member name="F:PacketDotNet.EthernetPacketType.IpV4">
<summary>
Internet Protocol, Version 4 (IPv4)
</summary>
</member>
<member name="F:PacketDotNet.EthernetPacketType.Arp">
<summary>
Address Resolution Protocol (ARP)
</summary>
</member>
<member name="F:PacketDotNet.EthernetPacketType.ReverseArp">
<summary>
Reverse Address Resolution Protocol (RARP)
</summary>
</member>
<member name="F:PacketDotNet.EthernetPacketType.WakeOnLan">
<summary>
Wake-On-Lan (WOL)
</summary>
</member>
<member name="F:PacketDotNet.EthernetPacketType.AppleTalk">
<summary>
AppleTalk (Ethertalk)
</summary>
</member>
<member name="F:PacketDotNet.EthernetPacketType.AppleTalkArp">
<summary>
AppleTalk Address Resolution Protocol (AARP)
</summary>
</member>
<member name="F:PacketDotNet.EthernetPacketType.VLanTaggedFrame">
<summary>
VLAN-tagged frame (IEEE 802.1Q)
</summary>
</member>
<member name="F:PacketDotNet.EthernetPacketType.NovellInternetworkPacketExchange">
<summary>
Novell IPX (alt)
</summary>
</member>
<member name="F:PacketDotNet.EthernetPacketType.Novell">
<summary>
Novell
</summary>
</member>
<member name="F:PacketDotNet.EthernetPacketType.IpV6">
<summary>
Internet Protocol, Version 6 (IPv6)
</summary>
</member>
<member name="F:PacketDotNet.EthernetPacketType.MacControl">
<summary>
MAC Control
</summary>
</member>
<member name="F:PacketDotNet.EthernetPacketType.CobraNet">
<summary>
CobraNet
</summary>
</member>
<member name="F:PacketDotNet.EthernetPacketType.MultiprotocolLabelSwitchingUnicast">
<summary>
MPLS unicast
</summary>
</member>
<member name="F:PacketDotNet.EthernetPacketType.MultiprotocolLabelSwitchingMulticast">
<summary>
MPLS multicast
</summary>
</member>
<member name="F:PacketDotNet.EthernetPacketType.PointToPointProtocolOverEthernetDiscoveryStage">
<summary>
PPPoE Discovery Stage
</summary>
</member>
<member name="F:PacketDotNet.EthernetPacketType.PointToPointProtocolOverEthernetSessionStage">
<summary>
PPPoE Session Stage
</summary>
</member>
<member name="F:PacketDotNet.EthernetPacketType.ExtensibleAuthenticationProtocolOverLan">
<summary>
EAP over LAN (IEEE 802.1X)
</summary>
</member>
<member name="F:PacketDotNet.EthernetPacketType.HyperScsi">
<summary>
HyperSCSI (SCSI over Ethernet)
</summary>
</member>
<member name="F:PacketDotNet.EthernetPacketType.AtaOverEthernet">
<summary>
ATA over Ethernet
</summary>
</member>
<member name="F:PacketDotNet.EthernetPacketType.EtherCatProtocol">
<summary>
EtherCAT Protocol
</summary>
</member>
<member name="F:PacketDotNet.EthernetPacketType.ProviderBridging">
<summary>
Provider Bridging (IEEE 802.1ad)
</summary>
</member>
<member name="F:PacketDotNet.EthernetPacketType.AvbTransportProtocol">
<summary>
AVB Transport Protocol (AVBTP)
</summary>
</member>
<member name="F:PacketDotNet.EthernetPacketType.LLDP">
<summary>
Link Layer Discovery Protocol (LLDP)
</summary>
</member>
<member name="F:PacketDotNet.EthernetPacketType.SerialRealTimeCommunicationSystemIii">
<summary>
SERCOS III
</summary>
</member>
<member name="F:PacketDotNet.EthernetPacketType.CircuitEmulationServicesOverEthernet">
<summary>
Circuit Emulation Services over Ethernet (MEF-8)
</summary>
</member>
<member name="F:PacketDotNet.EthernetPacketType.HomePlug">
<summary>
HomePlug
</summary>
</member>
<member name="F:PacketDotNet.EthernetPacketType.MacSecurity">
<summary>
MAC security (IEEE 802.1AE)
</summary>
</member>
<member name="F:PacketDotNet.EthernetPacketType.PrecisionTimeProtocol">
<summary>
Precision Time Protocol (IEEE 1588)
</summary>
</member>
<member name="F:PacketDotNet.EthernetPacketType.ConnectivityFaultManagementOrOperationsAdministrationManagement">
<summary>
IEEE 802.1ag Connectivity Fault Management (CFM) Protocol / ITU-T Recommendation Y.1731 (OAM)
</summary>
</member>
<member name="F:PacketDotNet.EthernetPacketType.FibreChannelOverEthernet">
<summary>
Fibre Channel over Ethernet
</summary>
</member>
<member name="F:PacketDotNet.EthernetPacketType.FibreChannelOverEthernetInitializationProtocol">
<summary>
FCoE Initialization Protocol
</summary>
</member>
<member name="F:PacketDotNet.EthernetPacketType.QInQ">
<summary>
Q-in-Q
</summary>
</member>
<member name="F:PacketDotNet.EthernetPacketType.VeritasLowLatencyTransport">
<summary>
Veritas Low Latency Transport (LLT)
</summary>
</member>
<member name="F:PacketDotNet.EthernetPacketType.Loop">
<summary>
Ethernet loopback packet
</summary>
</member>
<member name="F:PacketDotNet.EthernetPacketType.Echo">
<summary>
Ethernet echo packet
</summary>
</member>
<member name="T:PacketDotNet.Ieee80211FrameControlField">
<summary>
See http://www.ucertify.com/article/ieee-802-11-frame-format.html
</summary>
</member>
<member name="M:PacketDotNet.Ieee80211FrameControlField.#ctor(System.UInt16)">
<summary>
Constructor
</summary>
<param name="field">
A <see cref="T:System.UInt16" /></param>
</member>
<member name="T:PacketDotNet.Ieee80211FrameControlField.FrameTypes">
<summary>
Types of frames
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.ManagementAssociationRequest">
<summary>
Association request
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.ManagementAssociationResponse">
<summary>
Association response
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.ManagementReassociationRequest">
<summary>
Reassociation request
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.ManagementReassociationResponse">
<summary>
Reassociation response
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.ManagementProbeRequest">
<summary>
Probe request
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.ManagementProbeResponse">
<summary>
Probe response
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.ManagementReserved0">
<summary>
Reserved 0
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.ManagementReserved1">
<summary>
Reserved 1
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.ManagementBecon">
<summary>
Becon
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.ManagementATIM">
<summary>
ATIM
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.ManagementDisassociation">
<summary>
Disassociation
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.ManagementAuthentication">
<summary>
Authentication
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.ManagementDeauthentication">
<summary>
Deauthentication
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.ManagementReserved2">
<summary>
Reserved 2
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.ManagementReserved3">
<summary>
Reserved 3
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.ControlPSPoll">
<summary>
PS poll
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.ControlRTS">
<summary>
RTS
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.ControlCTS">
<summary>
CTS
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.ControlACK">
<summary>
ACK
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.ControlCFEnd">
<summary>
CF-End
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.ControlCFEndCFACK">
<summary>
CF-End CF-Ack
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.Data">
<summary>
Data
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.DataCFACK">
<summary>
CF-ACK
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.DataCFPoll">
<summary>
CF-Poll
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.DataCFAckCFPoll">
<summary>
CF-Ack CF-Poll
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.DataNullFunctionNoData">
<summary>
Null function no data
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.DataCFAckNoData">
<summary>
CF-Ack No data
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.DataCFPollNoData">
<summary>
CF-Poll no data
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211FrameControlField.FrameTypes.DataCFAckCFPollNoData">
<summary>
CF-Ack CF-Poll no data
</summary>
</member>
<member name="P:PacketDotNet.Ieee80211FrameControlField.ProtocolVersion">
<summary>
Protocol version
</summary>
</member>
<member name="P:PacketDotNet.Ieee80211FrameControlField.Types">
<summary>
Helps to identify the type of WLAN frame, control data and management are
the various frame types defined in IEEE 802.11
</summary>
</member>
<member name="P:PacketDotNet.Ieee80211FrameControlField.ToDS">
<summary>
Is set to 1 when the frame is sent to Distribution System (DS)
</summary>
</member>
<member name="P:PacketDotNet.Ieee80211FrameControlField.FromDS">
<summary>
Is set to 1 when the frame is received from the Distribution System (DS)
</summary>
</member>
<member name="P:PacketDotNet.Ieee80211FrameControlField.MoreFragments">
<summary>
More Fragment is set to 1 when there are more fragments belonging to the same
frame following the current fragment
</summary>
</member>
<member name="P:PacketDotNet.Ieee80211FrameControlField.Retry">
<summary>
Indicates that this fragment is a retransmission of a previously transmitted fragment.
(For receiver to recognize duplicate transmissions of frames)
</summary>
</member>
<member name="P:PacketDotNet.Ieee80211FrameControlField.PowerManagement">
<summary>
Indicates the power management mode that the station will be in after the transmission of the frame
</summary>
</member>
<member name="P:PacketDotNet.Ieee80211FrameControlField.MoreData">
<summary>
Indicates that there are more frames buffered for this station
</summary>
</member>
<member name="P:PacketDotNet.Ieee80211FrameControlField.Wep">
<summary>
Indicates that the frame body is encrypted according to the WEP (wired equivalent privacy) algorithm
</summary>
</member>
<member name="P:PacketDotNet.Ieee80211FrameControlField.Order">
<summary>
Bit is set when the "strict ordering" delivery method is employed. Frames and
fragments are not always sent in order as it causes a transmission performance penalty.
</summary>
</member>
<member name="T:PacketDotNet.Ieee80211MacFields">
<summary>
See http://www.ucertify.com/article/ieee-802-11-frame-format.html
NOTE: All positions are not defined here because the frame type changes
whether some address fields are present or not, causing the sequence control
field to move. In addition the payload size determines where the frame control
sequence value is as it is after the payload bytes, if any payload is present
</summary>
</member>
<member name="T:PacketDotNet.Ieee80211MacFrame">
<summary>
Packet class has common fields, FrameControl and Duration and
a specific object class that is set based on the type of
the frame
See http://www.ucertify.com/article/ieee-802-11-frame-format.html
</summary>
</member>
<member name="M:PacketDotNet.Ieee80211MacFrame.#ctor(PacketDotNet.Utils.ByteArraySegment)">
<summary>
Constructor
</summary>
<param name="bas">
A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
</member>
<member name="T:PacketDotNet.Ieee80211MacFrame.InnerFramePacket">
<summary>
Interfaces for all inner frames
</summary>
</member>
<member name="P:PacketDotNet.Ieee80211MacFrame.InnerFramePacket.FrameSize">
<summary>
Length of the frame
</summary>
</member>
<member name="T:PacketDotNet.Ieee80211MacFrame.RTSFrame">
<summary>
RTS Frame has a ReceiverAddress[6], TransmitterAddress[6] and a FrameCheckSequence[4],
these fields follow the common FrameControl[2] and DurationId[2] fields
</summary>
</member>
<member name="M:PacketDotNet.Ieee80211MacFrame.RTSFrame.#ctor(PacketDotNet.Ieee80211MacFrame,PacketDotNet.Utils.ByteArraySegment)">
<summary>
Constructor
</summary>
<param name="parent">
A <see cref="T:PacketDotNet.Ieee80211MacFrame" /></param>
<param name="bas">
A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
</member>
<member name="P:PacketDotNet.Ieee80211MacFrame.RTSFrame.ReceiverAddress">
<summary>
ReceiverAddress
</summary>
</member>
<member name="P:PacketDotNet.Ieee80211MacFrame.RTSFrame.TransmitterAddress">
<summary>
TransmitterAddress
</summary>
</member>
<member name="P:PacketDotNet.Ieee80211MacFrame.RTSFrame.FrameSize">
<summary>
Length of the frame
</summary>
</member>
<member name="M:PacketDotNet.Ieee80211MacFrame.RTSFrame.ToString">
<summary>
ToString() override
</summary>
<returns>
A <see cref="T:System.String" /></returns>
</member>
<member name="T:PacketDotNet.Ieee80211MacFrame.CTSOrACKFrame">
<summary>
Format of a CTS or an ACK frame
</summary>
</member>
<member name="M:PacketDotNet.Ieee80211MacFrame.CTSOrACKFrame.#ctor(PacketDotNet.Ieee80211MacFrame,PacketDotNet.Utils.ByteArraySegment)">
<summary>
Constructor
</summary>
<param name="parent">
A <see cref="T:PacketDotNet.Ieee80211MacFrame" /></param>
<param name="bas">
A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
</member>
<member name="P:PacketDotNet.Ieee80211MacFrame.CTSOrACKFrame.ReceiverAddress">
<summary>
Receiver address
</summary>
</member>
<member name="P:PacketDotNet.Ieee80211MacFrame.CTSOrACKFrame.FrameSize">
<summary>
Length of the frame
</summary>
</member>
<member name="M:PacketDotNet.Ieee80211MacFrame.CTSOrACKFrame.ToString">
<summary>
ToString() override
</summary>
<returns>
A <see cref="T:System.String" /></returns>
</member>
<member name="P:PacketDotNet.Ieee80211MacFrame.FrameControlBytes">
<summary>
Frame control bytes are the first two bytes of the frame
</summary>
</member>
<member name="P:PacketDotNet.Ieee80211MacFrame.FrameControl">
<summary>
Frame control field
</summary>
</member>
<member name="P:PacketDotNet.Ieee80211MacFrame.FrameCheckSequence">
<summary>
Frame check sequence, the last thing in the 802.11 mac packet
</summary>
</member>
<member name="P:PacketDotNet.Ieee80211MacFrame.InnerFrame">
<summary>
One of RTS, CTS etc frames
</summary>
</member>
<member name="M:PacketDotNet.Ieee80211MacFrame.SetAddress(System.Int32,System.Net.NetworkInformation.PhysicalAddress)">
<summary>
</summary>
<param name="addressIndex">Zero based address to look up</param>
<param name="address">
</param>
</member>
<member name="M:PacketDotNet.Ieee80211MacFrame.ToString">
<summary>
ToString() override
</summary>
<returns>
A <see cref="T:System.String" /></returns>
</member>
<member name="T:PacketDotNet.Ieee80211RadioPacket">
<summary>
.Net analog of a ieee80211_radiotap_header from airpcap.h
</summary>
</member>
<member name="P:PacketDotNet.Ieee80211RadioPacket.Version">
<summary>
Version 0. Only increases for drastic changes, introduction of compatible
new fields does not count.
</summary>
</member>
<member name="P:PacketDotNet.Ieee80211RadioPacket.Length">
<summary>
Length of the whole header in bytes, including it_version, it_pad, it_len
and data fields
</summary>
</member>
<member name="P:PacketDotNet.Ieee80211RadioPacket.Present">
<summary>
Returns an array of UInt32 bitmap entries. Each bit in the bitmap indicates
which fields are present. Set bit 31 (0x8000000)
to extend the bitmap by another 32 bits. Additional extensions are made
by setting bit 31.
</summary>
</member>
<member name="P:PacketDotNet.Ieee80211RadioPacket.RadioTapFields">
<summary>
Array of radio tap fields
</summary>
</member>
<member name="M:PacketDotNet.Ieee80211RadioPacket.ToString(PacketDotNet.StringOutputType)">
<summary cref="Packet.ToString(StringOutputType)" />
</member>
<member name="T:PacketDotNet.Ieee80211RadioFields">
<summary>
As defined by Airpcap.h
NOTE: PresentPosition may not be the only position present
as this the field can be extended if the high bit is set
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211RadioFields.VersionLength">
<summary>Length of the version field</summary>
</member>
<member name="F:PacketDotNet.Ieee80211RadioFields.PadLength">
<summary>Length of the pad field</summary>
</member>
<member name="F:PacketDotNet.Ieee80211RadioFields.LengthLength">
<summary>Length of the length field</summary>
</member>
<member name="F:PacketDotNet.Ieee80211RadioFields.PresentLength">
<summary>Length of the first present field (others may follow)</summary>
</member>
<member name="F:PacketDotNet.Ieee80211RadioFields.VersionPosition">
<summary>Position of the version field</summary>
</member>
<member name="F:PacketDotNet.Ieee80211RadioFields.PadPosition">
<summary>Position of the padding field</summary>
</member>
<member name="F:PacketDotNet.Ieee80211RadioFields.LengthPosition">
<summary>Position of the length field</summary>
</member>
<member name="F:PacketDotNet.Ieee80211RadioFields.PresentPosition">
<summary>Position of the first present field</summary>
</member>
<member name="F:PacketDotNet.Ieee80211RadioFields.DefaultHeaderLength">
<summary>Default header length, assuming one present field entry</summary>
</member>
<member name="T:PacketDotNet.Ieee80211RadioTapChannelFlags">
<summary>
Channel flags
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211RadioTapChannelFlags.IEEE80211_CHAN_TURBO">
<summary>Turbo channel</summary>
</member>
<member name="F:PacketDotNet.Ieee80211RadioTapChannelFlags.IEEE80211_CHAN_CCK">
<summary>CCK channel</summary>
</member>
<member name="F:PacketDotNet.Ieee80211RadioTapChannelFlags.IEEE80211_CHAN_OFDM">
<summary>OFDM channel</summary>
</member>
<member name="F:PacketDotNet.Ieee80211RadioTapChannelFlags.IEEE80211_CHAN_2GHZ">
<summary>2 GHz spectrum channel</summary>
</member>
<member name="F:PacketDotNet.Ieee80211RadioTapChannelFlags.IEEE80211_CHAN_5GHZ">
<summary>5 GHz spectrum channel</summary>
</member>
<member name="F:PacketDotNet.Ieee80211RadioTapChannelFlags.IEEE80211_CHAN_PASSIVE">
<summary>Only passive scan allowed</summary>
</member>
<member name="F:PacketDotNet.Ieee80211RadioTapChannelFlags.IEEE80211_CHAN_DYN">
<summary>Dynamic CCK-OFDM channel</summary>
</member>
<member name="F:PacketDotNet.Ieee80211RadioTapChannelFlags.IEEE80211_CHAN_GFSK">
<summary>GFSK channel (FHSS PHY)</summary>
</member>
<member name="F:PacketDotNet.Ieee80211RadioTapChannelFlags.IEEE80211_CHAN_STURBO">
<summary>11a static turbo channel only</summary>
</member>
<member name="T:PacketDotNet.ChannelRadioTapField">
<summary>
Channel field
</summary>
</member>
<member name="M:PacketDotNet.ChannelRadioTapField.#ctor(System.IO.BinaryReader)">
<summary>
Constructor
</summary>
<param name="br">
A <see cref="T:System.IO.BinaryReader" /></param>
</member>
<member name="F:PacketDotNet.ChannelRadioTapField.Flags">
<summary>
Channel flags
</summary>
</member>
<member name="P:PacketDotNet.ChannelRadioTapField.FieldType">
<summary>Type of the field</summary>
</member>
<member name="P:PacketDotNet.ChannelRadioTapField.FrequencyMHz">
<summary>
Frequency in MHz
</summary>
</member>
<member name="P:PacketDotNet.ChannelRadioTapField.Channel">
<summary>
Channel number derived from frequency
</summary>
</member>
<member name="M:PacketDotNet.ChannelRadioTapField.ChannelFromFrequencyMHz(System.Int32)">
<summary>
Convert a frequency to a channel
</summary>
<param name="frequencyMHz">
A <see cref="T:System.Int32" /></param>
<returns>
A <see cref="T:System.Int32" /></returns>
</member>
<member name="M:PacketDotNet.ChannelRadioTapField.ToString">
<summary>
ToString() override
</summary>
<returns>
A <see cref="T:System.String" /></returns>
</member>
<member name="T:PacketDotNet.FhssRadioTapField">
<summary>
Fhss radio tap field
</summary>
</member>
<member name="M:PacketDotNet.FhssRadioTapField.#ctor(System.IO.BinaryReader)">
<summary>
Constructor
</summary>
<param name="br">
A <see cref="T:System.IO.BinaryReader" /></param>
</member>
<member name="P:PacketDotNet.FhssRadioTapField.FieldType">
<summary>Type of the field</summary>
</member>
<member name="P:PacketDotNet.FhssRadioTapField.ChannelHoppingSet">
<summary>
Hop set
</summary>
</member>
<member name="P:PacketDotNet.FhssRadioTapField.Pattern">
<summary>
Hop pattern
</summary>
</member>
<member name="M:PacketDotNet.FhssRadioTapField.ToString">
<summary>
ToString() override
</summary>
<returns>
A <see cref="T:System.String" /></returns>
</member>
<member name="T:PacketDotNet.FlagsRadioTapField">
<summary>
Radio tap flags
</summary>
</member>
<member name="M:PacketDotNet.FlagsRadioTapField.#ctor(System.IO.BinaryReader)">
<summary>
Constructor
</summary>
<param name="br">
A <see cref="T:System.IO.BinaryReader" /></param>
</member>
<member name="F:PacketDotNet.FlagsRadioTapField.Flags">
<summary>
Flags set
</summary>
</member>
<member name="P:PacketDotNet.FlagsRadioTapField.FieldType">
<summary>Type of the field</summary>
</member>
<member name="M:PacketDotNet.FlagsRadioTapField.ToString">
<summary>
ToString() override
</summary>
<returns>
A <see cref="T:System.String" /></returns>
</member>
<member name="T:PacketDotNet.RateRadioTapField">
<summary>
Rate field
</summary>
</member>
<member name="M:PacketDotNet.RateRadioTapField.#ctor(System.IO.BinaryReader)">
<summary>
Constructor
</summary>
<param name="br">
A <see cref="T:System.IO.BinaryReader" /></param>
</member>
<member name="P:PacketDotNet.RateRadioTapField.FieldType">
<summary>Type of the field</summary>
</member>
<member name="P:PacketDotNet.RateRadioTapField.RateMbps">
<summary>
Rate in Mbps
</summary>
</member>
<member name="M:PacketDotNet.RateRadioTapField.ToString">
<summary>
ToString() override
</summary>
<returns>
A <see cref="T:System.String" /></returns>
</member>
<member name="T:PacketDotNet.DbAntennaSignalRadioTapField">
<summary>
Db antenna signal
</summary>
</member>
<member name="M:PacketDotNet.DbAntennaSignalRadioTapField.#ctor(System.IO.BinaryReader)">
<summary>
Constructor
</summary>
<param name="br">
A <see cref="T:System.IO.BinaryReader" /></param>
</member>
<member name="P:PacketDotNet.DbAntennaSignalRadioTapField.FieldType">
<summary>Type of the field</summary>
</member>
<member name="P:PacketDotNet.DbAntennaSignalRadioTapField.SignalStrengthdB">
<summary>
Signal strength in dB
</summary>
</member>
<member name="M:PacketDotNet.DbAntennaSignalRadioTapField.ToString">
<summary>
ToString() override
</summary>
<returns>
A <see cref="T:System.String" /></returns>
</member>
<member name="T:PacketDotNet.DbAntennaNoiseRadioTapField">
<summary>
Antenna noise in dB
</summary>
</member>
<member name="M:PacketDotNet.DbAntennaNoiseRadioTapField.#ctor(System.IO.BinaryReader)">
<summary>
Constructor
</summary>
<param name="br">
A <see cref="T:System.IO.BinaryReader" /></param>
</member>
<member name="P:PacketDotNet.DbAntennaNoiseRadioTapField.FieldType">
<summary>Type of the field</summary>
</member>
<member name="P:PacketDotNet.DbAntennaNoiseRadioTapField.AntennaNoisedB">
<summary>
Antenna noise in dB
</summary>
</member>
<member name="M:PacketDotNet.DbAntennaNoiseRadioTapField.ToString">
<summary>
ToString() override
</summary>
<returns>
A <see cref="T:System.String" /></returns>
</member>
<member name="T:PacketDotNet.AntennaRadioTapField">
<summary>
Antenna field
</summary>
</member>
<member name="M:PacketDotNet.AntennaRadioTapField.#ctor(System.IO.BinaryReader)">
<summary>
Constructor
</summary>
<param name="br">
A <see cref="T:System.IO.BinaryReader" /></param>
</member>
<member name="P:PacketDotNet.AntennaRadioTapField.FieldType">
<summary>Type of the field</summary>
</member>
<member name="P:PacketDotNet.AntennaRadioTapField.Antenna">
<summary>
Antenna number
</summary>
</member>
<member name="M:PacketDotNet.AntennaRadioTapField.ToString">
<summary>
ToString() override
</summary>
<returns>
A <see cref="T:System.String" /></returns>
</member>
<member name="T:PacketDotNet.DbmAntennaSignalRadioTapField">
<summary>
Antenna signal in dBm
</summary>
</member>
<member name="M:PacketDotNet.DbmAntennaSignalRadioTapField.#ctor(System.IO.BinaryReader)">
<summary>
Constructor
</summary>
<param name="br">
A <see cref="T:System.IO.BinaryReader" /></param>
</member>
<member name="P:PacketDotNet.DbmAntennaSignalRadioTapField.FieldType">
<summary>Type of the field</summary>
</member>
<member name="P:PacketDotNet.DbmAntennaSignalRadioTapField.AntennaSignalDbm">
<summary>
Antenna signal in dBm
</summary>
</member>
<member name="M:PacketDotNet.DbmAntennaSignalRadioTapField.ToString">
<summary>
ToString() override
</summary>
<returns>
A <see cref="T:System.String" /></returns>
</member>
<member name="T:PacketDotNet.DbmAntennaNoiseRadioTapField">
<summary>
Antenna noise in dBm
</summary>
</member>
<member name="M:PacketDotNet.DbmAntennaNoiseRadioTapField.#ctor(System.IO.BinaryReader)">
<summary>
Constructor
</summary>
<param name="br">
A <see cref="T:System.IO.BinaryReader" /></param>
</member>
<member name="P:PacketDotNet.DbmAntennaNoiseRadioTapField.FieldType">
<summary>Type of the field</summary>
</member>
<member name="P:PacketDotNet.DbmAntennaNoiseRadioTapField.AntennaNoisedBm">
<summary>
Antenna noise in dBm
</summary>
</member>
<member name="M:PacketDotNet.DbmAntennaNoiseRadioTapField.ToString">
<summary>
ToString() override
</summary>
<returns>
A <see cref="T:System.String" /></returns>
</member>
<member name="T:PacketDotNet.LockQualityRadioTapField">
<summary>
Lock quality
</summary>
</member>
<member name="M:PacketDotNet.LockQualityRadioTapField.#ctor(System.IO.BinaryReader)">
<summary>
Constructor
</summary>
<param name="br">
A <see cref="T:System.IO.BinaryReader" /></param>
</member>
<member name="P:PacketDotNet.LockQualityRadioTapField.FieldType">
<summary>Type of the field</summary>
</member>
<member name="P:PacketDotNet.LockQualityRadioTapField.SignalQuality">
<summary>
Signal quality
</summary>
</member>
<member name="M:PacketDotNet.LockQualityRadioTapField.ToString">
<summary>
ToString() override
</summary>
<returns>
A <see cref="T:System.String" /></returns>
</member>
<member name="T:PacketDotNet.TsftRadioTapField">
<summary>
Tsft radio tap field
</summary>
</member>
<member name="M:PacketDotNet.TsftRadioTapField.#ctor(System.IO.BinaryReader)">
<summary>
Constructor
</summary>
<param name="br">
A <see cref="T:System.IO.BinaryReader" /></param>
</member>
<member name="P:PacketDotNet.TsftRadioTapField.FieldType">
<summary>Type of the field</summary>
</member>
<member name="P:PacketDotNet.TsftRadioTapField.TimestampUsec">
<summary>
Timestamp in microseconds
</summary>
</member>
<member name="M:PacketDotNet.TsftRadioTapField.ToString">
<summary>
ToString() override
</summary>
<returns>
A <see cref="T:System.String" /></returns>
</member>
<member name="T:PacketDotNet.FcsRadioTapField">
<summary>
Fcs field
</summary>
</member>
<member name="M:PacketDotNet.FcsRadioTapField.#ctor(System.IO.BinaryReader)">
<summary>
Constructor
</summary>
<param name="br">
A <see cref="T:System.IO.BinaryReader" /></param>
</member>
<member name="P:PacketDotNet.FcsRadioTapField.FieldType">
<summary>Type of the field</summary>
</member>
<member name="P:PacketDotNet.FcsRadioTapField.FrameCheckSequence">
<summary>
Frame check sequence
</summary>
</member>
<member name="M:PacketDotNet.FcsRadioTapField.ToString">
<summary>
ToString() override
</summary>
<returns>
A <see cref="T:System.String" /></returns>
</member>
<member name="T:PacketDotNet.TxAttenuationRadioTapField">
<summary>
Transmit power expressed as unitless distance from max
power set at factory calibration. 0 is max power.
Monotonically nondecreasing with lower power levels.
</summary>
</member>
<member name="M:PacketDotNet.TxAttenuationRadioTapField.#ctor(System.IO.BinaryReader)">
<summary>
Constructor
</summary>
<param name="br">
A <see cref="T:System.IO.BinaryReader" /></param>
</member>
<member name="P:PacketDotNet.TxAttenuationRadioTapField.FieldType">
<summary>Type of the field</summary>
</member>
<member name="P:PacketDotNet.TxAttenuationRadioTapField.TxPower">
<summary>
Transmit power
</summary>
</member>
<member name="M:PacketDotNet.TxAttenuationRadioTapField.ToString">
<summary>
ToString() override
</summary>
<returns>
A <see cref="T:System.String" /></returns>
</member>
<member name="T:PacketDotNet.DbTxAttenuationRadioTapField">
<summary>
Transmit power expressed as decibel distance from max power
set at factory calibration. 0 is max power. Monotonically
nondecreasing with lower power levels.
</summary>
</member>
<member name="M:PacketDotNet.DbTxAttenuationRadioTapField.#ctor(System.IO.BinaryReader)">
<summary>
Constructor
</summary>
<param name="br">
A <see cref="T:System.IO.BinaryReader" /></param>
</member>
<member name="P:PacketDotNet.DbTxAttenuationRadioTapField.FieldType">
<summary>Type of the field</summary>
</member>
<member name="P:PacketDotNet.DbTxAttenuationRadioTapField.TxPowerdB">
<summary>
Transmit power
</summary>
</member>
<member name="M:PacketDotNet.DbTxAttenuationRadioTapField.ToString">
<summary>
ToString() override
</summary>
<returns>
A <see cref="T:System.String" /></returns>
</member>
<member name="T:PacketDotNet.DbmTxPowerRadioTapField">
<summary>
Transmit power expressed as dBm (decibels from a 1 milliwatt
reference). This is the absolute power level measured at
the antenna port.
</summary>
</member>
<member name="M:PacketDotNet.DbmTxPowerRadioTapField.#ctor(System.IO.BinaryReader)">
<summary>
Constructor
</summary>
<param name="br">
A <see cref="T:System.IO.BinaryReader" /></param>
</member>
<member name="P:PacketDotNet.DbmTxPowerRadioTapField.FieldType">
<summary>Type of the field</summary>
</member>
<member name="P:PacketDotNet.DbmTxPowerRadioTapField.TxPowerdBm">
<summary>
Tx power in dBm
</summary>
</member>
<member name="M:PacketDotNet.DbmTxPowerRadioTapField.ToString">
<summary>
ToString() override
</summary>
<returns>
A <see cref="T:System.String" /></returns>
</member>
<member name="T:PacketDotNet.RadioTapField">
<summary>
Abstract class for all radio tap fields
</summary>
</member>
<member name="P:PacketDotNet.RadioTapField.FieldType">
<summary>Type of the field</summary>
</member>
<member name="M:PacketDotNet.RadioTapField.Parse(System.Int32,System.IO.BinaryReader)">
<summary>
Parse a radio tap field, indicated by bitIndex, from a given BinaryReader
</summary>
<param name="bitIndex">
A <see cref="T:System.Int32" /></param>
<param name="br">
A <see cref="T:System.IO.BinaryReader" /></param>
<returns>
A <see cref="T:PacketDotNet.RadioTapField" /></returns>
</member>
<member name="T:PacketDotNet.Ieee80211RadioTapFlags">
<summary>
Radio tap flags
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211RadioTapFlags.CFP">
<summary>
sent/received during cfp
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211RadioTapFlags.ShortPreamble">
<summary>
sent/received with short preamble
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211RadioTapFlags.WepEncrypted">
<summary>
sent/received with WEP encryption
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211RadioTapFlags.Fragmentation">
<summary>
sent/received with fragmentation
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211RadioTapFlags.FcsIncludedInFrame">
<summary>
frame includes FCS
</summary>
</member>
<member name="T:PacketDotNet.Ieee80211RadioTapType">
<summary>
NOTE: Might be out-of-date information since it mentions Ethereal
NOTE: ethereal does NOT handle the following:
IEEE80211_RADIOTAP_FHSS:
IEEE80211_RADIOTAP_LOCK_QUALITY:
IEEE80211_RADIOTAP_TX_ATTENUATION:
IEEE80211_RADIOTAP_DB_TX_ATTENUATION:
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211RadioTapType.IEEE80211_RADIOTAP_TSFT">
<summary>
IEEE80211_RADIOTAP_TSFT u_int64_t microseconds
Value in microseconds of the MAC's 64-bit 802.11 Time
Synchronization Function timer when the first bit of the
MPDU arrived at the MAC. For received frames, only.
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211RadioTapType.IEEE80211_RADIOTAP_FLAGS">
<summary>
IEEE80211_RADIOTAP_FLAGS u_int8_t bitmap
Properties of transmitted and received frames. See flags
defined below.
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211RadioTapType.IEEE80211_RADIOTAP_RATE">
<summary>
IEEE80211_RADIOTAP_RATE u_int8_t 500kb/s
Tx/Rx data rate
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211RadioTapType.IEEE80211_RADIOTAP_CHANNEL">
<summary>
IEEE80211_RADIOTAP_CHANNEL 2 x u_int16_t MHz, bitmap
Tx/Rx frequency in MHz, followed by flags (see below).
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211RadioTapType.IEEE80211_RADIOTAP_FHSS">
<summary>
IEEE80211_RADIOTAP_FHSS u_int16_t see below
For frequency-hopping radios, the hop set (first byte)
and pattern (second byte).
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211RadioTapType.IEEE80211_RADIOTAP_DBM_ANTSIGNAL">
<summary>
IEEE80211_RADIOTAP_DBM_ANTSIGNAL int8_t decibels from
one milliwatt (dBm)
RF signal power at the antenna, decibel difference from
one milliwatt.
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211RadioTapType.IEEE80211_RADIOTAP_DBM_ANTNOISE">
<summary>
IEEE80211_RADIOTAP_DBM_ANTNOISE int8_t decibels from
one milliwatt (dBm)
RF noise power at the antenna, decibel difference from one
milliwatt.
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211RadioTapType.IEEE80211_RADIOTAP_LOCK_QUALITY">
<summary>
IEEE80211_RADIOTAP_LOCK_QUALITY u_int16_t unitless
Quality of Barker code lock. Unitless. Monotonically
nondecreasing with "better" lock strength. Called "Signal
Quality" in datasheets. (Is there a standard way to measure
this?)
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211RadioTapType.IEEE80211_RADIOTAP_TX_ATTENUATION">
<summary>
IEEE80211_RADIOTAP_TX_ATTENUATION u_int16_t unitless
Transmit power expressed as unitless distance from max
power set at factory calibration. 0 is max power.
Monotonically nondecreasing with lower power levels.
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211RadioTapType.IEEE80211_RADIOTAP_DB_TX_ATTENUATION">
<summary>
IEEE80211_RADIOTAP_DB_TX_ATTENUATION u_int16_t decibels (dB)
Transmit power expressed as decibel distance from max power
set at factory calibration. 0 is max power. Monotonically
nondecreasing with lower power levels.
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211RadioTapType.IEEE80211_RADIOTAP_DBM_TX_POWER">
<summary>
IEEE80211_RADIOTAP_DBM_TX_POWER int8_t decibels from
one milliwatt (dBm)
Transmit power expressed as dBm (decibels from a 1 milliwatt
reference). This is the absolute power level measured at
the antenna port.
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211RadioTapType.IEEE80211_RADIOTAP_ANTENNA">
<summary>
IEEE80211_RADIOTAP_ANTENNA u_int8_t antenna index
Unitless indication of the Rx/Tx antenna for this packet.
The first antenna is antenna 0.
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211RadioTapType.IEEE80211_RADIOTAP_DB_ANTSIGNAL">
<summary>
IEEE80211_RADIOTAP_DB_ANTSIGNAL u_int8_t decibel (dB)
RF signal power at the antenna, decibel difference from an
arbitrary, fixed reference.
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211RadioTapType.IEEE80211_RADIOTAP_DB_ANTNOISE">
<summary>
IEEE80211_RADIOTAP_DB_ANTNOISE u_int8_t decibel (dB)
RF noise power at the antenna, decibel difference from an
arbitrary, fixed reference point.
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211RadioTapType.IEEE80211_RADIOTAP_FCS">
<summary>
IEEE80211_RADIOTAP_FCS u_int32_t data
FCS from frame in network byte order.
</summary>
</member>
<member name="F:PacketDotNet.Ieee80211RadioTapType.IEEE80211_RADIOTAP_EXT">
<summary>
Indicates that the flags bitmaps have been extended
</summary>
</member>
<member name="T:PacketDotNet.IpPacket">
<summary>
Base class for IPv4 and IPv6 packets that exports the common
functionality that both of these classes has in common
</summary>
</member>
<member name="M:PacketDotNet.IpPacket.#ctor">
<summary>
IpPacket constructor
</summary>
</member>
<member name="F:PacketDotNet.IpPacket.DefaultTimeToLive">
<summary>
The default time to live value for Ip packets being constructed
</summary>
</member>
<member name="P:PacketDotNet.IpPacket.PayloadPacket">
<value>
Payload packet, overridden to set the NextHeader/Protocol based
on the type of payload packet when the payload packet is set
</value>
</member>
<member name="P:PacketDotNet.IpPacket.DestinationAddress">
<value>
The destination address
</value>
</member>
<member name="P:PacketDotNet.IpPacket.SourceAddress">
<value>
The source address
</value>
</member>
<member name="P:PacketDotNet.IpPacket.Version">
<value>
The IP version
</value>
</member>
<member name="P:PacketDotNet.IpPacket.Protocol">
<value>
The protocol of the ip packet's payload
Named 'Protocol' in IPv4
Named 'NextHeader' in IPv6'
</value>
</member>
<member name="P:PacketDotNet.IpPacket.NextHeader">
<value>
The protocol of the ip packet's payload
Included along side Protocol for user convienence
</value>
</member>
<member name="P:PacketDotNet.IpPacket.TimeToLive">
<value>
The number of hops remaining before this packet is discarded
Named 'TimeToLive' in IPv4
Named 'HopLimit' in IPv6
</value>
</member>
<member name="P:PacketDotNet.IpPacket.HopLimit">
<value>
The number of hops remaining for this packet
Included along side of TimeToLive for user convienence
</value>
</member>
<member name="P:PacketDotNet.IpPacket.HeaderLength">
<summary>
ipv4 header length field, calculated for ipv6 packets
NOTE: This field is the number of 32bit words in the ip header,
ie. the number of bytes is 4x this value
</summary>
</member>
<member name="P:PacketDotNet.IpPacket.TotalLength">
<summary>
ipv4 total number of bytes in the ipv4 header + payload,
ipv6 PayloadLength + IPv6Fields.HeaderLength
</summary>
</member>
<member name="P:PacketDotNet.IpPacket.PayloadLength">
<summary>
ipv6 payload length in bytes,
calculate from ipv4.TotalLength - (ipv4.HeaderLength * 4)
</summary>
</member>
<member name="M:PacketDotNet.IpPacket.AttachPseudoIPHeader(System.Byte[])">
<summary>
Adds a pseudo ip header to a given packet. Used to generate the full
byte array required to generate a udp or tcp checksum.
</summary>
<param name="origHeader">
A <see cref="T:System.Byte" /></param>
<returns>
A <see cref="T:System.Byte" /></returns>
</member>
<member name="M:PacketDotNet.IpPacket.GetIPAddress(System.Net.Sockets.AddressFamily,System.Int32,System.Byte[])">
<summary>
Convert an ip address from a byte[]
</summary>
<param name="ipType">
A <see cref="T:System.Net.Sockets.AddressFamily" /></param>
<param name="fieldOffset">
A <see cref="T:System.Int32" /></param>
<param name="bytes">
A <see cref="T:System.Byte" /></param>
<returns>
A <see cref="T:System.Net.IPAddress" /></returns>
</member>
<member name="M:PacketDotNet.IpPacket.ParseEncapsulatedBytes(PacketDotNet.Utils.ByteArraySegment,PacketDotNet.IPProtocolType,PacketDotNet.Packet)">
<summary>
Called by IPv4 and IPv6 packets to parse their packet payload
</summary>
<param name="payload">
A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
<param name="ProtocolType">
A <see cref="T:PacketDotNet.IPProtocolType" /></param>
<param name="ParentPacket">
A <see cref="T:PacketDotNet.Packet" /></param>
<returns>
A <see cref="T:PacketDotNet.PacketOrByteArraySegment" /></returns>
</member>
<member name="M:PacketDotNet.IpPacket.GetEncapsulated(PacketDotNet.Packet)">
<summary>
Returns the IpPacket inside of the Packet p or null if
there is no encapsulated packet
</summary>
<param name="p">
A <see cref="T:PacketDotNet.Packet" /></param>
<returns>
A <see cref="T:PacketDotNet.IpPacket" /></returns>
</member>
<member name="M:PacketDotNet.IpPacket.RandomPacket(PacketDotNet.IpVersion)">
<summary>
Generate a random packet of a specific ip version
</summary>
<param name="version">
A <see cref="T:PacketDotNet.IpVersion" /></param>
<returns>
A <see cref="T:PacketDotNet.IpPacket" /></returns>
</member>
<member name="T:PacketDotNet.Packet">
<summary>
Base class for all packet types.
Defines helper methods and accessors for the architecture that underlies how
packets interact and store their data.
</summary>
</member>
<member name="M:PacketDotNet.Packet.#ctor">
<summary>
Constructor
</summary>
</member>
<member name="P:PacketDotNet.Packet.SharesMemoryWithSubPackets">
<value>
Returns true if we already have a contiguous byte[] in either
of these conditions:
- This packet's header byte[] and payload byte[] are the same instance
or
- This packet's header byte[] and this packet's payload packet
are the same instance and the offsets indicate that the bytes
are contiguous
</value>
</member>
<member name="P:PacketDotNet.Packet.ParentPacket">
<summary>
The packet that is carrying this one
</summary>
</member>
<member name="P:PacketDotNet.Packet.Header">
<value>
Returns a
</value>
</member>
<member name="P:PacketDotNet.Packet.PayloadPacket">
<summary>
Packet that this packet carries if one is present.
Note that the packet MAY have a null PayloadPacket but
a non-null PayloadData
</summary>
</member>
<member name="P:PacketDotNet.Packet.PayloadData">
<summary>
Payload byte[] if one is present.
Note that the packet MAY have a null PayloadData but a
non-null PayloadPacket
</summary>
</member>
<member name="P:PacketDotNet.Packet.Bytes">
<summary>
byte[] containing this packet and its payload
NOTE: Use 'public virtual ByteArraySegment BytesHighPerformance' for highest performance
</summary>
</member>
<member name="P:PacketDotNet.Packet.BytesHighPerformance">
<value>
The option to return a ByteArraySegment means that this method
is higher performance as the data can start at an offset other than
the first byte.
</value>
</member>
<member name="P:PacketDotNet.Packet.Color">
<value>
Color used when generating the text description of a packet
</value>
</member>
<member name="M:PacketDotNet.Packet.ParsePacket(PacketDotNet.LinkLayers,System.Byte[])">
<summary>
Parse bytes into a packet
</summary>
<param name="LinkLayer">
A <see cref="T:PacketDotNet.LinkLayers" /></param>
<param name="PacketData">
A <see cref="T:System.Byte" /></param>
<returns>
A <see cref="T:PacketDotNet.Packet" /></returns>
</member>
<member name="M:PacketDotNet.Packet.RecursivelyUpdateCalculatedValues">
<summary>
Used to ensure that values like checksums and lengths are
properly updated
</summary>
</member>
<member name="M:PacketDotNet.Packet.UpdateCalculatedValues">
<summary>
Called to ensure that calculated values are updated before
the packet bytes are retrieved
Classes should override this method to update things like
checksums and lengths that take too much time or are too complex
to update for each packet parameter change
</summary>
</member>
<member name="M:PacketDotNet.Packet.ToString">
<summary>Output this packet as a readable string</summary>
</member>
<member name="M:PacketDotNet.Packet.ToString(PacketDotNet.StringOutputType)">
<summary cref="Packet.ToString()">
Output the packet information in the specified format
Normal - outputs the packet info to a single line
Colored - outputs the packet info to a single line with coloring
Verbose - outputs detailed info about the packet
VerboseColored - outputs detailed info about the packet with coloring
</summary>
<param name="outputFormat">
<see cref="T:PacketDotNet.StringOutputType" />
</param>
</member>
<member name="M:PacketDotNet.Packet.PrintHex">
<summary>
Prints the Packet PayloadData in Hex format
With the 16-byte segment number, raw bytes, and parsed ascii output
Ex:
0010 00 18 82 6c 7c 7f 00 c0 9f 77 a3 b0 88 64 11 00 ...1|... .w...d..
</summary>
<returns>
A <see cref="T:System.String" /></returns>
</member>
<member name="T:PacketDotNet.SessionPacket">
<summary>
Session layer packet
</summary>
</member>
<member name="M:PacketDotNet.SessionPacket.#ctor">
<summary>
Constructor
</summary>
</member>
<member name="T:PacketDotNet.TcpPacket">
<summary>
TcpPacket
See: http://en.wikipedia.org/wiki/Transmission_Control_Protocol
</summary>
</member>
<member name="M:PacketDotNet.TcpPacket.#ctor(System.UInt16,System.UInt16)">
<summary>
Create a new TCP packet from values
</summary>
</member>
<member name="M:PacketDotNet.TcpPacket.#ctor(PacketDotNet.Utils.ByteArraySegment)">
<summary>
Constructor
</summary>
<param name="bas">
A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
</member>
<member name="M:PacketDotNet.TcpPacket.#ctor(PacketDotNet.Utils.ByteArraySegment,PacketDotNet.Packet)">
<summary>
Constructor
</summary>
<param name="bas">
A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
<param name="ParentPacket">
A <see cref="T:PacketDotNet.Packet" /></param>
</member>
<member name="F:PacketDotNet.TcpPacket.HeaderMinimumLength">
<value>
20 bytes is the smallest tcp header
</value>
</member>
<member name="P:PacketDotNet.TcpPacket.SourcePort">
<summary> Fetch the port number on the source host.</summary>
</member>
<member name="P:PacketDotNet.TcpPacket.DestinationPort">
<summary> Fetches the port number on the destination host.</summary>
</member>
<member name="P:PacketDotNet.TcpPacket.SequenceNumber">
<summary> Fetch the packet sequence number.</summary>
</member>
<member name="P:PacketDotNet.TcpPacket.AcknowledgmentNumber">
<summary> Fetch the packet acknowledgment number.</summary>
</member>
<member name="P:PacketDotNet.TcpPacket.DataOffset">
<summary> The size of the tcp header in 32bit words </summary>
</member>
<member name="P:PacketDotNet.TcpPacket.WindowSize">
<summary>
The size of the receive window, which specifies the number of
bytes (beyond the sequence number in the acknowledgment field) that
the receiver is currently willing to receive.
</summary>
</member>
<member name="P:PacketDotNet.TcpPacket.Checksum">
<value>
Tcp checksum field value of type UInt16
</value>
</member>
<member name="P:PacketDotNet.TcpPacket.ValidChecksum">
<summary> Check if the TCP packet is valid, checksum-wise.</summary>
</member>
<member name="P:PacketDotNet.TcpPacket.ValidTCPChecksum">
<value>
True if the tcp checksum is valid
</value>
</member>
<member name="P:PacketDotNet.TcpPacket.AllFlags">
<summary>
Flags, 9 bits
TODO: Handle the NS bit
</summary>
</member>
<member name="P:PacketDotNet.TcpPacket.Urg">
<summary> Check the URG flag, flag indicates if the urgent pointer is valid.</summary>
</member>
<member name="P:PacketDotNet.TcpPacket.Ack">
<summary> Check the ACK flag, flag indicates if the ack number is valid.</summary>
</member>
<member name="P:PacketDotNet.TcpPacket.Psh">
<summary> Check the PSH flag, flag indicates the receiver should pass the
data to the application as soon as possible.
</summary>
</member>
<member name="P:PacketDotNet.TcpPacket.Rst">
<summary> Check the RST flag, flag indicates the session should be reset between
the sender and the receiver.
</summary>
</member>
<member name="P:PacketDotNet.TcpPacket.Syn">
<summary> Check the SYN flag, flag indicates the sequence numbers should
be synchronized between the sender and receiver to initiate
a connection.
</summary>
</member>
<member name="P:PacketDotNet.TcpPacket.Fin">
<summary> Check the FIN flag, flag indicates the sender is finished sending.</summary>
</member>
<member name="P:PacketDotNet.TcpPacket.ECN">
<value>
ECN flag
</value>
</member>
<member name="P:PacketDotNet.TcpPacket.CWR">
<value>
CWR flag
</value>
</member>
<member name="P:PacketDotNet.TcpPacket.Color">
<summary> Fetch ascii escape sequence of the color associated with this packet type.</summary>
</member>
<member name="P:PacketDotNet.TcpPacket.UrgentPointer">
<summary> Fetch the urgent pointer.</summary>
</member>
<member name="P:PacketDotNet.TcpPacket.Options">
<summary>
Bytes that represent the tcp options
</summary>
<returns>
A <see cref="T:System.String" /></returns>
</member>
<member name="P:PacketDotNet.TcpPacket.OptionsCollection">
<summary>
Contains the Options list attached to the TCP header
</summary>
</member>
<member name="M:PacketDotNet.TcpPacket.CalculateTCPChecksum">
<summary>
Computes the TCP checksum. Does not update the current checksum value
</summary>
<returns> The calculated TCP checksum.</returns>
</member>
<member name="M:PacketDotNet.TcpPacket.UpdateTCPChecksum">
<summary>
Update the checksum value.
</summary>
</member>
<!--FIXME: Invalid documentation markup was found for member M:PacketDotNet.TcpPacket.ParseOptions(System.Byte[])-->
<member name="M:PacketDotNet.TcpPacket.ToString(PacketDotNet.StringOutputType)">
<summary cref="Packet.ToString(StringOutputType)" />
</member>
<member name="M:PacketDotNet.TcpPacket.GetEncapsulated(PacketDotNet.Packet)">
<summary>
Returns the TcpPacket embedded in Packet p or null if
there is no embedded TcpPacket
</summary>
</member>
<member name="M:PacketDotNet.TcpPacket.RandomPacket">
<summary>
Create a randomized tcp packet with the given ip version
</summary>
<returns>
A <see cref="T:PacketDotNet.Packet" /></returns>
</member>
<member name="T:PacketDotNet.UdpPacket">
<summary>
User datagram protocol
See http://en.wikipedia.org/wiki/Udp
</summary>
</member>
<member name="M:PacketDotNet.UdpPacket.#ctor(System.UInt16,System.UInt16)">
<summary>
Create from values
</summary>
<param name="SourcePort">
A <see cref="T:System.UInt16" /></param>
<param name="DestinationPort">
A <see cref="T:System.UInt16" /></param>
</member>
<member name="M:PacketDotNet.UdpPacket.#ctor(PacketDotNet.Utils.ByteArraySegment)">
<summary>
Constructor
</summary>
<param name="bas">
A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
</member>
<member name="M:PacketDotNet.UdpPacket.#ctor(PacketDotNet.Utils.ByteArraySegment,PacketDotNet.Packet)">
<summary>
Constructor
</summary>
<param name="bas">
A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
<param name="ParentPacket">
A <see cref="T:PacketDotNet.Packet" /></param>
</member>
<member name="P:PacketDotNet.UdpPacket.SourcePort">
<summary> Fetch the port number on the source host.</summary>
</member>
<member name="P:PacketDotNet.UdpPacket.DestinationPort">
<summary> Fetch the port number on the target host.</summary>
</member>
<member name="P:PacketDotNet.UdpPacket.Length">
<value>
Length in bytes of the header and payload, minimum size of 8,
the size of the Udp header
</value>
</member>
<member name="P:PacketDotNet.UdpPacket.Checksum">
<summary> Fetch the header checksum.</summary>
</member>
<member name="P:PacketDotNet.UdpPacket.ValidChecksum">
<summary> Check if the UDP packet is valid, checksum-wise.</summary>
</member>
<member name="P:PacketDotNet.UdpPacket.ValidUDPChecksum">
<value>
True if the udp checksum is valid
</value>
</member>
<member name="P:PacketDotNet.UdpPacket.Color">
<summary> Fetch ascii escape sequence of the color associated with this packet type.</summary>
</member>
<member name="M:PacketDotNet.UdpPacket.UpdateCalculatedValues">
<summary>
Update the Udp length
</summary>
</member>
<member name="M:PacketDotNet.UdpPacket.CalculateUDPChecksum">
<summary>
Calculates the UDP checksum, optionally updating the UDP checksum header.
</summary>
<returns>The calculated UDP checksum.</returns>
</member>
<member name="M:PacketDotNet.UdpPacket.UpdateUDPChecksum">
<summary>
Update the checksum value.
</summary>
</member>
<member name="M:PacketDotNet.UdpPacket.ToString(PacketDotNet.StringOutputType)">
<summary cref="Packet.ToString(StringOutputType)" />
</member>
<member name="M:PacketDotNet.UdpPacket.GetEncapsulated(PacketDotNet.Packet)">
<summary>
Returns the UdpPacket inside of the Packet p or null if
there is no encapsulated packet
</summary>
<param name="p">
A <see cref="T:PacketDotNet.Packet" /></param>
<returns>
A <see cref="T:PacketDotNet.UdpPacket" /></returns>
</member>
<member name="M:PacketDotNet.UdpPacket.RandomPacket">
<summary>
Generate a random packet
</summary>
<returns>
A <see cref="T:PacketDotNet.UdpPacket" /></returns>
</member>
<member name="T:PacketDotNet.EthernetFields">
<summary>
Ethernet protocol field encoding information.
</summary>
</member>
<member name="F:PacketDotNet.EthernetFields.TypeLength">
<summary> Width of the ethernet type code in bytes.</summary>
</member>
<member name="F:PacketDotNet.EthernetFields.DestinationMacPosition">
<summary> Position of the destination MAC address within the ethernet header.</summary>
</member>
<member name="F:PacketDotNet.EthernetFields.SourceMacPosition">
<summary> Position of the source MAC address within the ethernet header.</summary>
</member>
<member name="F:PacketDotNet.EthernetFields.TypePosition">
<summary> Position of the ethernet type field within the ethernet header.</summary>
</member>
<member name="F:PacketDotNet.EthernetFields.HeaderLength">
<summary> Total length of an ethernet header in bytes.</summary>
</member>
<member name="F:PacketDotNet.EthernetFields.MacAddressLength">
<summary>
size of an ethernet mac address in bytes
</summary>
</member>
<member name="T:PacketDotNet.TransportPacket">
<summary>
Transport layer packet
</summary>
</member>
<member name="M:PacketDotNet.TransportPacket.#ctor">
<summary>
Constructor
</summary>
</member>
<member name="T:PacketDotNet.TransportPacket.TransportChecksumOption">
<summary>
Options for use when creating a transport layer checksum
</summary>
</member>
<member name="F:PacketDotNet.TransportPacket.TransportChecksumOption.None">
<summary>
No extra options
</summary>
</member>
<member name="F:PacketDotNet.TransportPacket.TransportChecksumOption.AttachPseudoIPHeader">
<summary>
Attach a pseudo IP header to the transport data being checksummed
</summary>
</member>
<member name="P:PacketDotNet.TransportPacket.Checksum">
<value>
The Checksum version
</value>
</member>
<member name="M:PacketDotNet.TransportPacket.CalculateChecksum(PacketDotNet.TransportPacket.TransportChecksumOption)">
<summary>
Calculates the transport layer checksum, either for the
tcp or udp packet
</summary>
<param name="option">
<see cref="T:PacketDotNet.TransportPacket.TransportChecksumOption" />
</param>
<returns>
A <see cref="T:System.Int32" /></returns>
</member>
<member name="M:PacketDotNet.TransportPacket.IsValidChecksum(PacketDotNet.TransportPacket.TransportChecksumOption)">
<summary>
Determine if the transport layer checksum is valid
</summary>
<param name="option">
A <see cref="T:PacketDotNet.TransportPacket.TransportChecksumOption" /></param>
<returns>
A <see cref="T:System.Boolean" /></returns>
</member>
<member name="T:PacketDotNet.Utils.AnsiEscapeSequences">
<summary> String constants for color console output.
<p>
This file contains control sequences to print color text on a text
console capable of interpreting and displaying control sequences.
</p><p>
A capable console would be
unix bash, os/2 shell, or command.com w/ ansi.sys loaded
</p></summary>
<author> Chris Cheetham
</author>
</member>
<member name="F:PacketDotNet.Utils.AnsiEscapeSequences.EscapeBegin">
<summary>
Delimits the start of an ansi color sequence, the color code goes after this
</summary>
</member>
<member name="F:PacketDotNet.Utils.AnsiEscapeSequences.EscapeEnd">
<summary>
Delimits the stop of the ansi color sequence, the color code comes before this
</summary>
</member>
<member name="T:PacketDotNet.UdpFields">
<summary>
Defines the lengths and positions of the udp fields within
a udp packet
</summary>
</member>
<member name="F:PacketDotNet.UdpFields.PortLength">
<summary> Length of a UDP port in bytes.</summary>
</member>
<member name="F:PacketDotNet.UdpFields.HeaderLengthLength">
<summary> Length of the header length field in bytes.</summary>
</member>
<member name="F:PacketDotNet.UdpFields.ChecksumLength">
<summary> Length of the checksum field in bytes.</summary>
</member>
<member name="F:PacketDotNet.UdpFields.SourcePortPosition">
<summary> Position of the source port.</summary>
</member>
<member name="F:PacketDotNet.UdpFields.DestinationPortPosition">
<summary> Position of the destination port.</summary>
</member>
<member name="F:PacketDotNet.UdpFields.HeaderLengthPosition">
<summary> Position of the header length.</summary>
</member>
<member name="F:PacketDotNet.UdpFields.ChecksumPosition">
<summary> Position of the header checksum length.</summary>
</member>
<member name="F:PacketDotNet.UdpFields.HeaderLength">
<summary> Length of a UDP header in bytes.</summary>
</member>
<member name="T:MiscUtil.IO.EndianBinaryReader">
<summary>
Equivalent of System.IO.BinaryReader, but with either endianness, depending on
the EndianBitConverter it is constructed with. No data is buffered in the
reader; the client may seek within the stream at will.
</summary>
</member>
<member name="M:MiscUtil.IO.EndianBinaryReader.#ctor(MiscUtil.Conversion.EndianBitConverter,System.IO.Stream)">
<summary>
Equivalent of System.IO.BinaryWriter, but with either endianness, depending on
the EndianBitConverter it is constructed with.
</summary>
<param name="bitConverter">Converter to use when reading data</param>
<param name="stream">Stream to read data from</param>
</member>
<member name="M:MiscUtil.IO.EndianBinaryReader.#ctor(MiscUtil.Conversion.EndianBitConverter,System.IO.Stream,System.Text.Encoding)">
<summary>
Constructs a new binary reader with the given bit converter, reading
to the given stream, using the given encoding.
</summary>
<param name="bitConverter">Converter to use when reading data</param>
<param name="stream">Stream to read data from</param>
<param name="encoding">Encoding to use when reading character data</param>
</member>
<member name="F:MiscUtil.IO.EndianBinaryReader.disposed">
<summary>
Whether or not this reader has been disposed yet.
</summary>
</member>
<member name="F:MiscUtil.IO.EndianBinaryReader.decoder">
<summary>
Decoder to use for string conversions.
</summary>
</member>
<member name="F:MiscUtil.IO.EndianBinaryReader.buffer">
<summary>
Buffer used for temporary storage before conversion into primitives
</summary>
</member>
<member name="F:MiscUtil.IO.EndianBinaryReader.charBuffer">
<summary>
Buffer used for temporary storage when reading a single character
</summary>
</member>
<member name="F:MiscUtil.IO.EndianBinaryReader.minBytesPerChar">
<summary>
Minimum number of bytes used to encode a character
</summary>
</member>
<member name="P:MiscUtil.IO.EndianBinaryReader.BitConverter">
<summary>
The bit converter used to read values from the stream
</summary>
</member>
<member name="P:MiscUtil.IO.EndianBinaryReader.Encoding">
<summary>
The encoding used to read strings
</summary>
</member>
<member name="P:MiscUtil.IO.EndianBinaryReader.BaseStream">
<summary>
Gets the underlying stream of the EndianBinaryReader.
</summary>
</member>
<member name="M:MiscUtil.IO.EndianBinaryReader.Close">
<summary>
Closes the reader, including the underlying stream..
</summary>
</member>
<member name="M:MiscUtil.IO.EndianBinaryReader.Seek(System.Int32,System.IO.SeekOrigin)">
<summary>
Seeks within the stream.
</summary>
<param name="offset">Offset to seek to.</param>
<param name="origin">Origin of seek operation.</param>
</member>
<member name="M:MiscUtil.IO.EndianBinaryReader.ReadByte">
<summary>
Reads a single byte from the stream.
</summary>
<returns>The byte read</returns>
</member>
<member name="M:MiscUtil.IO.EndianBinaryReader.ReadSByte">
<summary>
Reads a single signed byte from the stream.
</summary>
<returns>The byte read</returns>
</member>
<member name="M:MiscUtil.IO.EndianBinaryReader.ReadBoolean">
<summary>
Reads a boolean from the stream. 1 byte is read.
</summary>
<returns>The boolean read</returns>
</member>
<member name="M:MiscUtil.IO.EndianBinaryReader.ReadInt16">
<summary>
Reads a 16-bit signed integer from the stream, using the bit converter
for this reader. 2 bytes are read.
</summary>
<returns>The 16-bit integer read</returns>
</member>
<member name="M:MiscUtil.IO.EndianBinaryReader.ReadInt32">
<summary>
Reads a 32-bit signed integer from the stream, using the bit converter
for this reader. 4 bytes are read.
</summary>
<returns>The 32-bit integer read</returns>
</member>
<member name="M:MiscUtil.IO.EndianBinaryReader.ReadInt64">
<summary>
Reads a 64-bit signed integer from the stream, using the bit converter
for this reader. 8 bytes are read.
</summary>
<returns>The 64-bit integer read</returns>
</member>
<member name="M:MiscUtil.IO.EndianBinaryReader.ReadUInt16">
<summary>
Reads a 16-bit unsigned integer from the stream, using the bit converter
for this reader. 2 bytes are read.
</summary>
<returns>The 16-bit unsigned integer read</returns>
</member>
<member name="M:MiscUtil.IO.EndianBinaryReader.ReadUInt32">
<summary>
Reads a 32-bit unsigned integer from the stream, using the bit converter
for this reader. 4 bytes are read.
</summary>
<returns>The 32-bit unsigned integer read</returns>
</member>
<member name="M:MiscUtil.IO.EndianBinaryReader.ReadUInt64">
<summary>
Reads a 64-bit unsigned integer from the stream, using the bit converter
for this reader. 8 bytes are read.
</summary>
<returns>The 64-bit unsigned integer read</returns>
</member>
<member name="M:MiscUtil.IO.EndianBinaryReader.ReadSingle">
<summary>
Reads a single-precision floating-point value from the stream, using the bit converter
for this reader. 4 bytes are read.
</summary>
<returns>The floating point value read</returns>
</member>
<member name="M:MiscUtil.IO.EndianBinaryReader.ReadDouble">
<summary>
Reads a double-precision floating-point value from the stream, using the bit converter
for this reader. 8 bytes are read.
</summary>
<returns>The floating point value read</returns>
</member>
<member name="M:MiscUtil.IO.EndianBinaryReader.ReadDecimal">
<summary>
Reads a decimal value from the stream, using the bit converter
for this reader. 16 bytes are read.
</summary>
<returns>The decimal value read</returns>
</member>
<member name="M:MiscUtil.IO.EndianBinaryReader.Read">
<summary>
Reads a single character from the stream, using the character encoding for
this reader. If no characters have been fully read by the time the stream ends,
-1 is returned.
</summary>
<returns>The character read, or -1 for end of stream.</returns>
</member>
<member name="M:MiscUtil.IO.EndianBinaryReader.Read(System.Char[],System.Int32,System.Int32)">
<summary>
Reads the specified number of characters into the given buffer, starting at
the given index.
</summary>
<param name="data">The buffer to copy data into</param>
<param name="index">The first index to copy data into</param>
<param name="count">The number of characters to read</param>
<returns>The number of characters actually read. This will only be less than
the requested number of characters if the end of the stream is reached.
</returns>
</member>
<member name="M:MiscUtil.IO.EndianBinaryReader.Read(System.Byte[],System.Int32,System.Int32)">
<summary>
Reads the specified number of bytes into the given buffer, starting at
the given index.
</summary>
<param name="buffer">The buffer to copy data into</param>
<param name="index">The first index to copy data into</param>
<param name="count">The number of bytes to read</param>
<returns>The number of bytes actually read. This will only be less than
the requested number of bytes if the end of the stream is reached.
</returns>
</member>
<member name="M:MiscUtil.IO.EndianBinaryReader.ReadBytes(System.Int32)">
<summary>
Reads the specified number of bytes, returning them in a new byte array.
If not enough bytes are available before the end of the stream, this
method will return what is available.
</summary>
<param name="count">The number of bytes to read</param>
<returns>The bytes read</returns>
</member>
<member name="M:MiscUtil.IO.EndianBinaryReader.ReadBytesOrThrow(System.Int32)">
<summary>
Reads the specified number of bytes, returning them in a new byte array.
If not enough bytes are available before the end of the stream, this
method will throw an IOException.
</summary>
<param name="count">The number of bytes to read</param>
<returns>The bytes read</returns>
</member>
<member name="M:MiscUtil.IO.EndianBinaryReader.Read7BitEncodedInt">
<summary>
Reads a 7-bit encoded integer from the stream. This is stored with the least significant
information first, with 7 bits of information per byte of value, and the top
bit as a continuation flag. This method is not affected by the endianness
of the bit converter.
</summary>
<returns>The 7-bit encoded integer read from the stream.</returns>
</member>
<member name="M:MiscUtil.IO.EndianBinaryReader.ReadBigEndian7BitEncodedInt">
<summary>
Reads a 7-bit encoded integer from the stream. This is stored with the most significant
information first, with 7 bits of information per byte of value, and the top
bit as a continuation flag. This method is not affected by the endianness
of the bit converter.
</summary>
<returns>The 7-bit encoded integer read from the stream.</returns>
</member>
<member name="M:MiscUtil.IO.EndianBinaryReader.ReadString">
<summary>
Reads a length-prefixed string from the stream, using the encoding for this reader.
A 7-bit encoded integer is first read, which specifies the number of bytes
to read from the stream. These bytes are then converted into a string with
the encoding for this reader.
</summary>
<returns>The string read from the stream.</returns>
</member>
<member name="M:MiscUtil.IO.EndianBinaryReader.CheckDisposed">
<summary>
Checks whether or not the reader has been disposed, throwing an exception if so.
</summary>
</member>
<member name="M:MiscUtil.IO.EndianBinaryReader.ReadInternal(System.Byte[],System.Int32)">
<summary>
Reads the given number of bytes from the stream, throwing an exception
if they can't all be read.
</summary>
<param name="data">Buffer to read into</param>
<param name="size">Number of bytes to read</param>
</member>
<member name="M:MiscUtil.IO.EndianBinaryReader.TryReadInternal(System.Byte[],System.Int32)">
<summary>
Reads the given number of bytes from the stream if possible, returning
the number of bytes actually read, which may be less than requested if
(and only if) the end of the stream is reached.
</summary>
<param name="data">Buffer to read into</param>
<param name="size">Number of bytes to read</param>
<returns>Number of bytes actually read</returns>
</member>
<member name="M:MiscUtil.IO.EndianBinaryReader.Dispose">
<summary>
Disposes of the underlying stream.
</summary>
</member>
<member name="T:MiscUtil.IO.EndianBinaryWriter">
<summary>
Equivalent of System.IO.BinaryWriter, but with either endianness, depending on
the EndianBitConverter it is constructed with.
</summary>
</member>
<member name="M:MiscUtil.IO.EndianBinaryWriter.#ctor(MiscUtil.Conversion.EndianBitConverter,System.IO.Stream)">
<summary>
Constructs a new binary writer with the given bit converter, writing
to the given stream, using UTF-8 encoding.
</summary>
<param name="bitConverter">Converter to use when writing data</param>
<param name="stream">Stream to write data to</param>
</member>
<member name="M:MiscUtil.IO.EndianBinaryWriter.#ctor(MiscUtil.Conversion.EndianBitConverter,System.IO.Stream,System.Text.Encoding)">
<summary>
Constructs a new binary writer with the given bit converter, writing
to the given stream, using the given encoding.
</summary>
<param name="bitConverter">Converter to use when writing data</param>
<param name="stream">Stream to write data to</param>
<param name="encoding">Encoding to use when writing character data</param>
</member>
<member name="F:MiscUtil.IO.EndianBinaryWriter.disposed">
<summary>
Whether or not this writer has been disposed yet.
</summary>
</member>
<member name="F:MiscUtil.IO.EndianBinaryWriter.buffer">
<summary>
Buffer used for temporary storage during conversion from primitives
</summary>
</member>
<member name="F:MiscUtil.IO.EndianBinaryWriter.charBuffer">
<summary>
Buffer used for Write(char)
</summary>
</member>
<member name="P:MiscUtil.IO.EndianBinaryWriter.BitConverter">
<summary>
The bit converter used to write values to the stream
</summary>
</member>
<member name="P:MiscUtil.IO.EndianBinaryWriter.Encoding">
<summary>
The encoding used to write strings
</summary>
</member>
<member name="P:MiscUtil.IO.EndianBinaryWriter.BaseStream">
<summary>
Gets the underlying stream of the EndianBinaryWriter.
</summary>
</member>
<member name="M:MiscUtil.IO.EndianBinaryWriter.Close">
<summary>
Closes the writer, including the underlying stream.
</summary>
</member>
<member name="M:MiscUtil.IO.EndianBinaryWriter.Flush">
<summary>
Flushes the underlying stream.
</summary>
</member>
<member name="M:MiscUtil.IO.EndianBinaryWriter.Seek(System.Int32,System.IO.SeekOrigin)">
<summary>
Seeks within the stream.
</summary>
<param name="offset">Offset to seek to.</param>
<param name="origin">Origin of seek operation.</param>
</member>
<member name="M:MiscUtil.IO.EndianBinaryWriter.Write(System.Boolean)">
<summary>
Writes a boolean value to the stream. 1 byte is written.
</summary>
<param name="value">The value to write</param>
</member>
<member name="M:MiscUtil.IO.EndianBinaryWriter.Write(System.Int16)">
<summary>
Writes a 16-bit signed integer to the stream, using the bit converter
for this writer. 2 bytes are written.
</summary>
<param name="value">The value to write</param>
</member>
<member name="M:MiscUtil.IO.EndianBinaryWriter.Write(System.Int32)">
<summary>
Writes a 32-bit signed integer to the stream, using the bit converter
for this writer. 4 bytes are written.
</summary>
<param name="value">The value to write</param>
</member>
<member name="M:MiscUtil.IO.EndianBinaryWriter.Write(System.Int64)">
<summary>
Writes a 64-bit signed integer to the stream, using the bit converter
for this writer. 8 bytes are written.
</summary>
<param name="value">The value to write</param>
</member>
<member name="M:MiscUtil.IO.EndianBinaryWriter.Write(System.UInt16)">
<summary>
Writes a 16-bit unsigned integer to the stream, using the bit converter
for this writer. 2 bytes are written.
</summary>
<param name="value">The value to write</param>
</member>
<member name="M:MiscUtil.IO.EndianBinaryWriter.Write(System.UInt32)">
<summary>
Writes a 32-bit unsigned integer to the stream, using the bit converter
for this writer. 4 bytes are written.
</summary>
<param name="value">The value to write</param>
</member>
<member name="M:MiscUtil.IO.EndianBinaryWriter.Write(System.UInt64)">
<summary>
Writes a 64-bit unsigned integer to the stream, using the bit converter
for this writer. 8 bytes are written.
</summary>
<param name="value">The value to write</param>
</member>
<member name="M:MiscUtil.IO.EndianBinaryWriter.Write(System.Single)">
<summary>
Writes a single-precision floating-point value to the stream, using the bit converter
for this writer. 4 bytes are written.
</summary>
<param name="value">The value to write</param>
</member>
<member name="M:MiscUtil.IO.EndianBinaryWriter.Write(System.Double)">
<summary>
Writes a double-precision floating-point value to the stream, using the bit converter
for this writer. 8 bytes are written.
</summary>
<param name="value">The value to write</param>
</member>
<member name="M:MiscUtil.IO.EndianBinaryWriter.Write(System.Decimal)">
<summary>
Writes a decimal value to the stream, using the bit converter for this writer.
16 bytes are written.
</summary>
<param name="value">The value to write</param>
</member>
<member name="M:MiscUtil.IO.EndianBinaryWriter.Write(System.Byte)">
<summary>
Writes a signed byte to the stream.
</summary>
<param name="value">The value to write</param>
</member>
<member name="M:MiscUtil.IO.EndianBinaryWriter.Write(System.SByte)">
<summary>
Writes an unsigned byte to the stream.
</summary>
<param name="value">The value to write</param>
</member>
<member name="M:MiscUtil.IO.EndianBinaryWriter.Write(System.Byte[])">
<summary>
Writes an array of bytes to the stream.
</summary>
<param name="value">The values to write</param>
</member>
<member name="M:MiscUtil.IO.EndianBinaryWriter.Write(System.Byte[],System.Int32,System.Int32)">
<summary>
Writes a portion of an array of bytes to the stream.
</summary>
<param name="value">An array containing the bytes to write</param>
<param name="offset">The index of the first byte to write within the array</param>
<param name="count">The number of bytes to write</param>
</member>
<member name="M:MiscUtil.IO.EndianBinaryWriter.Write(System.Char)">
<summary>
Writes a single character to the stream, using the encoding for this writer.
</summary>
<param name="value">The value to write</param>
</member>
<member name="M:MiscUtil.IO.EndianBinaryWriter.Write(System.Char[])">
<summary>
Writes an array of characters to the stream, using the encoding for this writer.
</summary>
<param name="value">An array containing the characters to write</param>
</member>
<member name="M:MiscUtil.IO.EndianBinaryWriter.Write(System.String)">
<summary>
Writes a string to the stream, using the encoding for this writer.
</summary>
<param name="value">The value to write. Must not be null.</param>
<exception cref="T:System.ArgumentNullException">value is null</exception>
</member>
<member name="M:MiscUtil.IO.EndianBinaryWriter.Write7BitEncodedInt(System.Int32)">
<summary>
Writes a 7-bit encoded integer from the stream. This is stored with the least significant
information first, with 7 bits of information per byte of value, and the top
bit as a continuation flag.
</summary>
<param name="value">The 7-bit encoded integer to write to the stream</param>
</member>
<member name="M:MiscUtil.IO.EndianBinaryWriter.CheckDisposed">
<summary>
Checks whether or not the writer has been disposed, throwing an exception if so.
</summary>
</member>
<member name="M:MiscUtil.IO.EndianBinaryWriter.WriteInternal(System.Byte[],System.Int32)">
<summary>
Writes the specified number of bytes from the start of the given byte array,
after checking whether or not the writer has been disposed.
</summary>
<param name="bytes">The array of bytes to write from</param>
<param name="length">The number of bytes to write</param>
</member>
<member name="M:MiscUtil.IO.EndianBinaryWriter.Dispose">
<summary>
Disposes of the underlying stream.
</summary>
</member>
<member name="T:MiscUtil.Conversion.BigEndianBitConverter">
<summary>
Implementation of EndianBitConverter which converts to/from big-endian
byte arrays.
</summary>
</member>
<member name="P:MiscUtil.Conversion.BigEndianBitConverter.Endianness">
<summary>
Indicates the byte order ("endianess") in which data is converted using this class.
</summary>
</member>
<member name="M:MiscUtil.Conversion.BigEndianBitConverter.IsLittleEndian">
<summary>
Indicates the byte order ("endianess") in which data is converted using this class.
</summary>
<remarks>
Different computer architectures store data using different byte orders. "Big-endian"
means the most significant byte is on the left end of a word. "Little-endian" means the
most significant byte is on the right end of a word.
</remarks>
<returns>true if this converter is little-endian, false otherwise.</returns>
</member>
<member name="M:MiscUtil.Conversion.BigEndianBitConverter.CopyBytesImpl(System.Int64,System.Int32,System.Byte[],System.Int32)">
<summary>
Copies the specified number of bytes from value to buffer, starting at index.
</summary>
<param name="value">The value to copy</param>
<param name="bytes">The number of bytes to copy</param>
<param name="buffer">The buffer to copy the bytes into</param>
<param name="index">The index to start at</param>
</member>
<member name="M:MiscUtil.Conversion.BigEndianBitConverter.FromBytes(System.Byte[],System.Int32,System.Int32)">
<summary>
Returns a value built from the specified number of bytes from the given buffer,
starting at index.
</summary>
<param name="buffer">The data in byte array format</param>
<param name="startIndex">The first index to use</param>
<param name="bytesToConvert">The number of bytes to use</param>
<returns>The value built from the given bytes</returns>
</member>
<member name="T:MiscUtil.Conversion.DoubleConverter">
<summary>
A class to allow the conversion of doubles to string representations of
their exact decimal values. The implementation aims for readability over
efficiency.
</summary>
</member>
<member name="T:MiscUtil.Conversion.DoubleConverter.ArbitraryDecimal">
<summary>
Private class used for manipulating sequences of decimal digits.
</summary>
</member>
<member name="M:MiscUtil.Conversion.DoubleConverter.ArbitraryDecimal.#ctor(System.Int64)">
<summary>
Constructs an arbitrary decimal expansion from the given long.
The long must not be negative.
</summary>
</member>
<member name="F:MiscUtil.Conversion.DoubleConverter.ArbitraryDecimal.digits">
<summary>Digits in the decimal expansion, one byte per digit</summary>
</member>
<member name="F:MiscUtil.Conversion.DoubleConverter.ArbitraryDecimal.decimalPoint">
<summary>
How many digits are *after* the decimal point
</summary>
</member>
<member name="M:MiscUtil.Conversion.DoubleConverter.ArbitraryDecimal.MultiplyBy(System.Int32)">
<summary>
Multiplies the current expansion by the given amount, which should
only be 2 or 5.
</summary>
</member>
<member name="M:MiscUtil.Conversion.DoubleConverter.ArbitraryDecimal.Shift(System.Int32)">
<summary>
Shifts the decimal point; a negative value makes
the decimal expansion bigger (as fewer digits come after the
decimal place) and a positive value makes the decimal
expansion smaller.
</summary>
</member>
<member name="M:MiscUtil.Conversion.DoubleConverter.ArbitraryDecimal.Normalize">
<summary>
Removes leading/trailing zeroes from the expansion.
</summary>
</member>
<member name="M:MiscUtil.Conversion.DoubleConverter.ArbitraryDecimal.ToString">
<summary>
Converts the value to a proper decimal string representation.
</summary>
</member>
<member name="M:MiscUtil.Conversion.DoubleConverter.ToExactString(System.Double)">
<summary>
Converts the given double to a string representation of its
exact decimal value.
</summary>
<param name="d">The double to convert.</param>
<returns>A string representation of the double's exact decimal value.</returns>
</member>
<member name="T:MiscUtil.Conversion.EndianBitConverter">
<summary>
Equivalent of System.BitConverter, but with either endianness.
</summary>
</member>
<member name="T:MiscUtil.Conversion.EndianBitConverter.Int32SingleUnion">
<summary>
Union used solely for the equivalent of DoubleToInt64Bits and vice versa.
</summary>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.Int32SingleUnion.#ctor(System.Int32)">
<summary>
Creates an instance representing the given integer.
</summary>
<param name="i">The integer value of the new instance.</param>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.Int32SingleUnion.#ctor(System.Single)">
<summary>
Creates an instance representing the given floating point number.
</summary>
<param name="f">The floating point value of the new instance.</param>
</member>
<member name="F:MiscUtil.Conversion.EndianBitConverter.Int32SingleUnion.i">
<summary>
Int32 version of the value.
</summary>
</member>
<member name="F:MiscUtil.Conversion.EndianBitConverter.Int32SingleUnion.f">
<summary>
Single version of the value.
</summary>
</member>
<member name="P:MiscUtil.Conversion.EndianBitConverter.Int32SingleUnion.AsInt32">
<summary>
Returns the value of the instance as an integer.
</summary>
</member>
<member name="P:MiscUtil.Conversion.EndianBitConverter.Int32SingleUnion.AsSingle">
<summary>
Returns the value of the instance as a floating point number.
</summary>
</member>
<member name="P:MiscUtil.Conversion.EndianBitConverter.Endianness">
<summary>
Indicates the byte order ("endianess") in which data is converted using this class.
</summary>
</member>
<member name="P:MiscUtil.Conversion.EndianBitConverter.Little">
<summary>
Returns a little-endian bit converter instance. The same instance is
always returned.
</summary>
</member>
<member name="P:MiscUtil.Conversion.EndianBitConverter.Big">
<summary>
Returns a big-endian bit converter instance. The same instance is
always returned.
</summary>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.IsLittleEndian">
<summary>
Indicates the byte order ("endianess") in which data is converted using this class.
</summary>
<remarks>
Different computer architectures store data using different byte orders. "Big-endian"
means the most significant byte is on the left end of a word. "Little-endian" means the
most significant byte is on the right end of a word.
</remarks>
<returns>true if this converter is little-endian, false otherwise.</returns>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.DoubleToInt64Bits(System.Double)">
<summary>
Converts the specified double-precision floating point number to a
64-bit signed integer. Note: the endianness of this converter does not
affect the returned value.
</summary>
<param name="value">The number to convert. </param>
<returns>A 64-bit signed integer whose value is equivalent to value.</returns>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.Int64BitsToDouble(System.Int64)">
<summary>
Converts the specified 64-bit signed integer to a double-precision
floating point number. Note: the endianness of this converter does not
affect the returned value.
</summary>
<param name="value">The number to convert. </param>
<returns>A double-precision floating point number whose value is equivalent to value.</returns>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.SingleToInt32Bits(System.Single)">
<summary>
Converts the specified single-precision floating point number to a
32-bit signed integer. Note: the endianness of this converter does not
affect the returned value.
</summary>
<param name="value">The number to convert. </param>
<returns>A 32-bit signed integer whose value is equivalent to value.</returns>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.Int32BitsToSingle(System.Int32)">
<summary>
Converts the specified 32-bit signed integer to a single-precision floating point
number. Note: the endianness of this converter does not
affect the returned value.
</summary>
<param name="value">The number to convert. </param>
<returns>A single-precision floating point number whose value is equivalent to value.</returns>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.ToBoolean(System.Byte[],System.Int32)">
<summary>
Returns a Boolean value converted from one byte at a specified position in a byte array.
</summary>
<param name="value">An array of bytes.</param>
<param name="startIndex">The starting position within value.</param>
<returns>true if the byte at startIndex in value is nonzero; otherwise, false.</returns>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.ToChar(System.Byte[],System.Int32)">
<summary>
Returns a Unicode character converted from two bytes at a specified position in a byte array.
</summary>
<param name="value">An array of bytes.</param>
<param name="startIndex">The starting position within value.</param>
<returns>A character formed by two bytes beginning at startIndex.</returns>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.ToDouble(System.Byte[],System.Int32)">
<summary>
Returns a double-precision floating point number converted from eight bytes
at a specified position in a byte array.
</summary>
<param name="value">An array of bytes.</param>
<param name="startIndex">The starting position within value.</param>
<returns>A double precision floating point number formed by eight bytes beginning at startIndex.</returns>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.ToSingle(System.Byte[],System.Int32)">
<summary>
Returns a single-precision floating point number converted from four bytes
at a specified position in a byte array.
</summary>
<param name="value">An array of bytes.</param>
<param name="startIndex">The starting position within value.</param>
<returns>A single precision floating point number formed by four bytes beginning at startIndex.</returns>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.ToInt16(System.Byte[],System.Int32)">
<summary>
Returns a 16-bit signed integer converted from two bytes at a specified position in a byte array.
</summary>
<param name="value">An array of bytes.</param>
<param name="startIndex">The starting position within value.</param>
<returns>A 16-bit signed integer formed by two bytes beginning at startIndex.</returns>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.ToInt32(System.Byte[],System.Int32)">
<summary>
Returns a 32-bit signed integer converted from four bytes at a specified position in a byte array.
</summary>
<param name="value">An array of bytes.</param>
<param name="startIndex">The starting position within value.</param>
<returns>A 32-bit signed integer formed by four bytes beginning at startIndex.</returns>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.ToInt64(System.Byte[],System.Int32)">
<summary>
Returns a 64-bit signed integer converted from eight bytes at a specified position in a byte array.
</summary>
<param name="value">An array of bytes.</param>
<param name="startIndex">The starting position within value.</param>
<returns>A 64-bit signed integer formed by eight bytes beginning at startIndex.</returns>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.ToUInt16(System.Byte[],System.Int32)">
<summary>
Returns a 16-bit unsigned integer converted from two bytes at a specified position in a byte array.
</summary>
<param name="value">An array of bytes.</param>
<param name="startIndex">The starting position within value.</param>
<returns>A 16-bit unsigned integer formed by two bytes beginning at startIndex.</returns>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.ToUInt32(System.Byte[],System.Int32)">
<summary>
Returns a 32-bit unsigned integer converted from four bytes at a specified position in a byte array.
</summary>
<param name="value">An array of bytes.</param>
<param name="startIndex">The starting position within value.</param>
<returns>A 32-bit unsigned integer formed by four bytes beginning at startIndex.</returns>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.ToUInt64(System.Byte[],System.Int32)">
<summary>
Returns a 64-bit unsigned integer converted from eight bytes at a specified position in a byte array.
</summary>
<param name="value">An array of bytes.</param>
<param name="startIndex">The starting position within value.</param>
<returns>A 64-bit unsigned integer formed by eight bytes beginning at startIndex.</returns>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.CheckByteArgument(System.Byte[],System.Int32,System.Int32)">
<summary>
Checks the given argument for validity.
</summary>
<param name="value">The byte array passed in</param>
<param name="startIndex">The start index passed in</param>
<param name="bytesRequired">The number of bytes required</param>
<exception cref="T:System.ArgumentNullException">value is a null reference</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
startIndex is less than zero or greater than the length of value minus bytesRequired.
</exception>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.CheckedFromBytes(System.Byte[],System.Int32,System.Int32)">
<summary>
Checks the arguments for validity before calling FromBytes
(which can therefore assume the arguments are valid).
</summary>
<param name="value">The bytes to convert after checking</param>
<param name="startIndex">The index of the first byte to convert</param>
<param name="bytesToConvert">The number of bytes to convert</param>
<returns>
</returns>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.FromBytes(System.Byte[],System.Int32,System.Int32)">
<summary>
Convert the given number of bytes from the given array, from the given start
position, into a long, using the bytes as the least significant part of the long.
By the time this is called, the arguments have been checked for validity.
</summary>
<param name="value">The bytes to convert</param>
<param name="startIndex">The index of the first byte to convert</param>
<param name="bytesToConvert">The number of bytes to use in the conversion</param>
<returns>The converted number</returns>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.ToString(System.Byte[])">
<summary>
Returns a String converted from the elements of a byte array.
</summary>
<param name="value">An array of bytes.</param>
<remarks>All the elements of value are converted.</remarks>
<returns>
A String of hexadecimal pairs separated by hyphens, where each pair
represents the corresponding element in value; for example, "7F-2C-4A".
</returns>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.ToString(System.Byte[],System.Int32)">
<summary>
Returns a String converted from the elements of a byte array starting at a specified array position.
</summary>
<param name="value">An array of bytes.</param>
<param name="startIndex">The starting position within value.</param>
<remarks>The elements from array position startIndex to the end of the array are converted.</remarks>
<returns>
A String of hexadecimal pairs separated by hyphens, where each pair
represents the corresponding element in value; for example, "7F-2C-4A".
</returns>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.ToString(System.Byte[],System.Int32,System.Int32)">
<summary>
Returns a String converted from a specified number of bytes at a specified position in a byte array.
</summary>
<param name="value">An array of bytes.</param>
<param name="startIndex">The starting position within value.</param>
<param name="length">The number of bytes to convert.</param>
<remarks>The length elements from array position startIndex are converted.</remarks>
<returns>
A String of hexadecimal pairs separated by hyphens, where each pair
represents the corresponding element in value; for example, "7F-2C-4A".
</returns>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.ToDecimal(System.Byte[],System.Int32)">
<summary>
Returns a decimal value converted from sixteen bytes
at a specified position in a byte array.
</summary>
<param name="value">An array of bytes.</param>
<param name="startIndex">The starting position within value.</param>
<returns>A decimal formed by sixteen bytes beginning at startIndex.</returns>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.GetBytes(System.Decimal)">
<summary>
Returns the specified decimal value as an array of bytes.
</summary>
<param name="value">The number to convert.</param>
<returns>An array of bytes with length 16.</returns>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.CopyBytes(System.Decimal,System.Byte[],System.Int32)">
<summary>
Copies the specified decimal value into the specified byte array,
beginning at the specified index.
</summary>
<param name="value">A character to convert.</param>
<param name="buffer">The byte array to copy the bytes into</param>
<param name="index">The first index into the array to copy the bytes into</param>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.GetBytes(System.Int64,System.Int32)">
<summary>
Returns an array with the given number of bytes formed
from the least significant bytes of the specified value.
This is used to implement the other GetBytes methods.
</summary>
<param name="value">The value to get bytes for</param>
<param name="bytes">The number of significant bytes to return</param>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.GetBytes(System.Boolean)">
<summary>
Returns the specified Boolean value as an array of bytes.
</summary>
<param name="value">A Boolean value.</param>
<returns>An array of bytes with length 1.</returns>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.GetBytes(System.Char)">
<summary>
Returns the specified Unicode character value as an array of bytes.
</summary>
<param name="value">A character to convert.</param>
<returns>An array of bytes with length 2.</returns>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.GetBytes(System.Double)">
<summary>
Returns the specified double-precision floating point value as an array of bytes.
</summary>
<param name="value">The number to convert.</param>
<returns>An array of bytes with length 8.</returns>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.GetBytes(System.Int16)">
<summary>
Returns the specified 16-bit signed integer value as an array of bytes.
</summary>
<param name="value">The number to convert.</param>
<returns>An array of bytes with length 2.</returns>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.GetBytes(System.Int32)">
<summary>
Returns the specified 32-bit signed integer value as an array of bytes.
</summary>
<param name="value">The number to convert.</param>
<returns>An array of bytes with length 4.</returns>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.GetBytes(System.Int64)">
<summary>
Returns the specified 64-bit signed integer value as an array of bytes.
</summary>
<param name="value">The number to convert.</param>
<returns>An array of bytes with length 8.</returns>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.GetBytes(System.Single)">
<summary>
Returns the specified single-precision floating point value as an array of bytes.
</summary>
<param name="value">The number to convert.</param>
<returns>An array of bytes with length 4.</returns>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.GetBytes(System.UInt16)">
<summary>
Returns the specified 16-bit unsigned integer value as an array of bytes.
</summary>
<param name="value">The number to convert.</param>
<returns>An array of bytes with length 2.</returns>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.GetBytes(System.UInt32)">
<summary>
Returns the specified 32-bit unsigned integer value as an array of bytes.
</summary>
<param name="value">The number to convert.</param>
<returns>An array of bytes with length 4.</returns>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.GetBytes(System.UInt64)">
<summary>
Returns the specified 64-bit unsigned integer value as an array of bytes.
</summary>
<param name="value">The number to convert.</param>
<returns>An array of bytes with length 8.</returns>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.CopyBytes(System.Int64,System.Int32,System.Byte[],System.Int32)">
<summary>
Copies the given number of bytes from the least-specific
end of the specified value into the specified byte array, beginning
at the specified index.
This is used to implement the other CopyBytes methods.
</summary>
<param name="value">The value to copy bytes for</param>
<param name="bytes">The number of significant bytes to copy</param>
<param name="buffer">The byte array to copy the bytes into</param>
<param name="index">The first index into the array to copy the bytes into</param>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.CopyBytesImpl(System.Int64,System.Int32,System.Byte[],System.Int32)">
<summary>
Copies the given number of bytes from the least-specific
end of the specified value into the specified byte array, beginning
at the specified index.
This must be implemented in concrete derived classes, but the implementation
may assume that the value will fit into the buffer.
</summary>
<param name="value">The value to copy bytes for</param>
<param name="bytes">The number of significant bytes to copy</param>
<param name="buffer">The byte array to copy the bytes into</param>
<param name="index">The first index into the array to copy the bytes into</param>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.CopyBytes(System.Boolean,System.Byte[],System.Int32)">
<summary>
Copies the specified Boolean value into the specified byte array,
beginning at the specified index.
</summary>
<param name="value">A Boolean value.</param>
<param name="buffer">The byte array to copy the bytes into</param>
<param name="index">The first index into the array to copy the bytes into</param>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.CopyBytes(System.Char,System.Byte[],System.Int32)">
<summary>
Copies the specified Unicode character value into the specified byte array,
beginning at the specified index.
</summary>
<param name="value">A character to convert.</param>
<param name="buffer">The byte array to copy the bytes into</param>
<param name="index">The first index into the array to copy the bytes into</param>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.CopyBytes(System.Double,System.Byte[],System.Int32)">
<summary>
Copies the specified double-precision floating point value into the specified byte array,
beginning at the specified index.
</summary>
<param name="value">The number to convert.</param>
<param name="buffer">The byte array to copy the bytes into</param>
<param name="index">The first index into the array to copy the bytes into</param>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.CopyBytes(System.Int16,System.Byte[],System.Int32)">
<summary>
Copies the specified 16-bit signed integer value into the specified byte array,
beginning at the specified index.
</summary>
<param name="value">The number to convert.</param>
<param name="buffer">The byte array to copy the bytes into</param>
<param name="index">The first index into the array to copy the bytes into</param>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.CopyBytes(System.Int32,System.Byte[],System.Int32)">
<summary>
Copies the specified 32-bit signed integer value into the specified byte array,
beginning at the specified index.
</summary>
<param name="value">The number to convert.</param>
<param name="buffer">The byte array to copy the bytes into</param>
<param name="index">The first index into the array to copy the bytes into</param>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.CopyBytes(System.Int64,System.Byte[],System.Int32)">
<summary>
Copies the specified 64-bit signed integer value into the specified byte array,
beginning at the specified index.
</summary>
<param name="value">The number to convert.</param>
<param name="buffer">The byte array to copy the bytes into</param>
<param name="index">The first index into the array to copy the bytes into</param>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.CopyBytes(System.Single,System.Byte[],System.Int32)">
<summary>
Copies the specified single-precision floating point value into the specified byte array,
beginning at the specified index.
</summary>
<param name="value">The number to convert.</param>
<param name="buffer">The byte array to copy the bytes into</param>
<param name="index">The first index into the array to copy the bytes into</param>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.CopyBytes(System.UInt16,System.Byte[],System.Int32)">
<summary>
Copies the specified 16-bit unsigned integer value into the specified byte array,
beginning at the specified index.
</summary>
<param name="value">The number to convert.</param>
<param name="buffer">The byte array to copy the bytes into</param>
<param name="index">The first index into the array to copy the bytes into</param>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.CopyBytes(System.UInt32,System.Byte[],System.Int32)">
<summary>
Copies the specified 32-bit unsigned integer value into the specified byte array,
beginning at the specified index.
</summary>
<param name="value">The number to convert.</param>
<param name="buffer">The byte array to copy the bytes into</param>
<param name="index">The first index into the array to copy the bytes into</param>
</member>
<member name="M:MiscUtil.Conversion.EndianBitConverter.CopyBytes(System.UInt64,System.Byte[],System.Int32)">
<summary>
Copies the specified 64-bit unsigned integer value into the specified byte array,
beginning at the specified index.
</summary>
<param name="value">The number to convert.</param>
<param name="buffer">The byte array to copy the bytes into</param>
<param name="index">The first index into the array to copy the bytes into</param>
</member>
<member name="T:MiscUtil.Conversion.Endianness">
<summary>
Endianness of a converter
</summary>
</member>
<member name="F:MiscUtil.Conversion.Endianness.LittleEndian">
<summary>
Little endian - least significant byte first
</summary>
</member>
<member name="F:MiscUtil.Conversion.Endianness.BigEndian">
<summary>
Big endian - most significant byte first
</summary>
</member>
<member name="T:MiscUtil.Conversion.LittleEndianBitConverter">
<summary>
Implementation of EndianBitConverter which converts to/from little-endian
byte arrays.
</summary>
</member>
<member name="P:MiscUtil.Conversion.LittleEndianBitConverter.Endianness">
<summary>
Indicates the byte order ("endianess") in which data is converted using this class.
</summary>
</member>
<member name="M:MiscUtil.Conversion.LittleEndianBitConverter.IsLittleEndian">
<summary>
Indicates the byte order ("endianess") in which data is converted using this class.
</summary>
<remarks>
Different computer architectures store data using different byte orders. "Big-endian"
means the most significant byte is on the left end of a word. "Little-endian" means the
most significant byte is on the right end of a word.
</remarks>
<returns>true if this converter is little-endian, false otherwise.</returns>
</member>
<member name="M:MiscUtil.Conversion.LittleEndianBitConverter.CopyBytesImpl(System.Int64,System.Int32,System.Byte[],System.Int32)">
<summary>
Copies the specified number of bytes from value to buffer, starting at index.
</summary>
<param name="value">The value to copy</param>
<param name="bytes">The number of bytes to copy</param>
<param name="buffer">The buffer to copy the bytes into</param>
<param name="index">The index to start at</param>
</member>
<member name="M:MiscUtil.Conversion.LittleEndianBitConverter.FromBytes(System.Byte[],System.Int32,System.Int32)">
<summary>
Returns a value built from the specified number of bytes from the given buffer,
starting at index.
</summary>
<param name="buffer">The data in byte array format</param>
<param name="startIndex">The first index to use</param>
<param name="bytesToConvert">The number of bytes to use</param>
<returns>The value built from the given bytes</returns>
</member>
<member name="T:PacketDotNet.InternetPacket">
<summary>
Internet packets include IPv4, IPv6, IGMP etc, see
http://en.wikipedia.org/wiki/Internet_Layer
</summary>
</member>
<member name="M:PacketDotNet.InternetPacket.#ctor">
<summary>
Constructor
</summary>
</member>
<member name="T:PacketDotNet.IPv4Fields">
<summary>
IP protocol field encoding information.
</summary>
</member>
<member name="F:PacketDotNet.IPv4Fields.VersionAndHeaderLengthLength">
<summary> Width of the IP version and header length field in bytes.</summary>
</member>
<member name="F:PacketDotNet.IPv4Fields.DifferentiatedServicesLength">
<summary> Width of the Differentiated Services / Type of service field in bytes.</summary>
</member>
<member name="F:PacketDotNet.IPv4Fields.TotalLengthLength">
<summary> Width of the total length field in bytes.</summary>
</member>
<member name="F:PacketDotNet.IPv4Fields.IdLength">
<summary> Width of the ID field in bytes.</summary>
</member>
<member name="F:PacketDotNet.IPv4Fields.FragmentOffsetAndFlagsLength">
<summary> Width of the fragment offset bits and offset field in bytes.</summary>
</member>
<member name="F:PacketDotNet.IPv4Fields.TtlLength">
<summary> Width of the TTL field in bytes.</summary>
</member>
<member name="F:PacketDotNet.IPv4Fields.ProtocolLength">
<summary> Width of the IP protocol code in bytes.</summary>
</member>
<member name="F:PacketDotNet.IPv4Fields.ChecksumLength">
<summary> Width of the IP checksum in bytes.</summary>
</member>
<member name="F:PacketDotNet.IPv4Fields.VersionAndHeaderLengthPosition">
<summary> Position of the version code and header length within the IP header.</summary>
</member>
<member name="F:PacketDotNet.IPv4Fields.DifferentiatedServicesPosition">
<summary> Position of the differentiated services value within the IP header.</summary>
</member>
<member name="F:PacketDotNet.IPv4Fields.TotalLengthPosition">
<summary> Position of the header length within the IP header.</summary>
</member>
<member name="F:PacketDotNet.IPv4Fields.IdPosition">
<summary> Position of the packet ID within the IP header.</summary>
</member>
<member name="F:PacketDotNet.IPv4Fields.FragmentOffsetAndFlagsPosition">
<summary> Position of the flag bits and fragment offset within the IP header.</summary>
</member>
<member name="F:PacketDotNet.IPv4Fields.TtlPosition">
<summary> Position of the ttl within the IP header.</summary>
</member>
<member name="F:PacketDotNet.IPv4Fields.ProtocolPosition">
<summary>
Position of the protocol used within the IP data
</summary>
</member>
<member name="F:PacketDotNet.IPv4Fields.ChecksumPosition">
<summary> Position of the checksum within the IP header.</summary>
</member>
<member name="F:PacketDotNet.IPv4Fields.SourcePosition">
<summary> Position of the source IP address within the IP header.</summary>
</member>
<member name="F:PacketDotNet.IPv4Fields.DestinationPosition">
<summary> Position of the destination IP address within a packet.</summary>
</member>
<member name="F:PacketDotNet.IPv4Fields.HeaderLength">
<summary> Length in bytes of an IP header, excluding options.</summary>
</member>
<member name="F:PacketDotNet.IPv4Fields.AddressLength">
<summary>
Number of bytes in an IPv4 address
</summary>
</member>
<member name="T:PacketDotNet.IPv4Packet">
<summary>
IPv4 packet
See http://en.wikipedia.org/wiki/IPv4 for into
</summary>
</member>
<member name="M:PacketDotNet.IPv4Packet.#ctor(System.Net.IPAddress,System.Net.IPAddress)">
<summary>
Construct an instance by values
</summary>
</member>
<member name="M:PacketDotNet.IPv4Packet.#ctor(PacketDotNet.Utils.ByteArraySegment)">
<summary>
Constructor
</summary>
<param name="bas">
A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
</member>
<member name="T:PacketDotNet.IPv4Packet.TypesOfService_Fields">
<summary> Type of service code constants for IP. Type of service describes
how a packet should be handled.
<p>
TOS is an 8-bit record in an IP header which contains a 3-bit
precendence field, 4 TOS bit fields and a 0 bit.
</p><p>
The following constants are bit masks which can be logically and'ed
with the 8-bit IP TOS field to determine what type of service is set.
</p><p>
Taken from TCP/IP Illustrated V1 by Richard Stevens, p34.
</p></summary>
</member>
<member name="F:PacketDotNet.IPv4Packet.HeaderMinimumLength">
<value>
Number of bytes in the smallest valid ipv4 packet
</value>
</member>
<member name="F:PacketDotNet.IPv4Packet.ipVersion">
<value>
Version number of the IP protocol being used
</value>
</member>
<member name="P:PacketDotNet.IPv4Packet.Version">
<summary> Get the IP version code.</summary>
</member>
<member name="P:PacketDotNet.IPv4Packet.PayloadLength">
<value>
Forwards compatibility IPv6.PayloadLength property
</value>
</member>
<member name="P:PacketDotNet.IPv4Packet.HeaderLength">
<summary>
The IP header length field. At most, this can be a
four-bit value. The high order bits beyond the fourth bit
will be ignored.
</summary>
<param name="length">The length of the IP header in 32-bit words.
</param>
</member>
<member name="P:PacketDotNet.IPv4Packet.Id">
<summary>
The unique ID of this IP datagram. The ID normally
increments by one each time a datagram is sent by a host.
A 16-bit unsigned integer.
</summary>
</member>
<member name="P:PacketDotNet.IPv4Packet.FragmentOffset">
<summary>
Fragmentation offset
The offset specifies a number of octets (i.e., bytes).
A 13-bit unsigned integer.
</summary>
</member>
<member name="P:PacketDotNet.IPv4Packet.SourceAddress">
<summary> Fetch the IP address of the host where the packet originated from.</summary>
</member>
<member name="P:PacketDotNet.IPv4Packet.DestinationAddress">
<summary> Fetch the IP address of the host where the packet is destined.</summary>
</member>
<member name="P:PacketDotNet.IPv4Packet.Checksum">
<summary> Fetch the header checksum.</summary>
</member>
<member name="P:PacketDotNet.IPv4Packet.ValidChecksum">
<summary> Check if the IP packet is valid, checksum-wise.</summary>
</member>
<member name="P:PacketDotNet.IPv4Packet.ValidIPChecksum">
<summary>
Check if the IP packet header is valid, checksum-wise.
</summary>
</member>
<member name="P:PacketDotNet.IPv4Packet.Color">
<summary> Fetch ascii escape sequence of the color associated with this packet type.</summary>
</member>
<member name="P:PacketDotNet.IPv4Packet.DifferentiatedServices">
<summary> Fetch the type of service. </summary>
</member>
<member name="P:PacketDotNet.IPv4Packet.TypeOfService">
<value>
Renamed to DifferentiatedServices in IPv6 but present here
for backwards compatibility
</value>
</member>
<member name="P:PacketDotNet.IPv4Packet.TotalLength">
<value>
The entire datagram size including header and data
</value>
</member>
<member name="P:PacketDotNet.IPv4Packet.FragmentFlags">
<summary> Fetch fragment flags.</summary>
<param name="flags">A 3-bit unsigned integer.</param>
</member>
<member name="P:PacketDotNet.IPv4Packet.TimeToLive">
<summary> Fetch the time to live. TTL sets the upper limit on the number of
routers through which this IP datagram is allowed to pass.
Originally intended to be the number of seconds the packet lives it is now decremented
by one each time a router passes the packet on
8-bit value
</summary>
</member>
<member name="P:PacketDotNet.IPv4Packet.Protocol">
<summary> Fetch the code indicating the type of protocol embedded in the IP</summary>
<seealso cref="T:PacketDotNet.IPProtocolType">
</seealso>
</member>
<member name="M:PacketDotNet.IPv4Packet.CalculateIPChecksum">
<summary>
Calculates the IP checksum, optionally updating the IP checksum header.
</summary>
<returns> The calculated IP checksum.
</returns>
</member>
<member name="M:PacketDotNet.IPv4Packet.UpdateIPChecksum">
<summary>
Update the checksum value
</summary>
</member>
<member name="M:PacketDotNet.IPv4Packet.AttachPseudoIPHeader(System.Byte[])">
<summary>
Prepend to the given byte[] origHeader the portion of the IPv6 header used for
generating an tcp checksum
http://en.wikipedia.org/wiki/Transmission_Control_Protocol#TCP_checksum_using_IPv4
http://tools.ietf.org/html/rfc793
</summary>
<param name="origHeader">
A <see cref="T:System.Byte" /></param>
<returns>
A <see cref="T:System.Byte" /></returns>
</member>
<member name="M:PacketDotNet.IPv4Packet.ToString(PacketDotNet.StringOutputType)">
<summary cref="Packet.ToString(StringOutputType)" />
</member>
<member name="M:PacketDotNet.IPv4Packet.RandomPacket">
<summary>
Generate a random packet
</summary>
<returns>
A <see cref="T:PacketDotNet.Packet" /></returns>
</member>
<member name="M:PacketDotNet.IPv4Packet.UpdateCalculatedValues">
<summary>
Update the length fields
</summary>
</member>
<member name="T:PacketDotNet.IPv6Fields">
<summary>
A struct containing length and position information about IPv6 Fields.
</summary>
</member>
<member name="M:PacketDotNet.IPv6Fields.#ctor">
<summary>
Commutes the field positions.
</summary>
</member>
<member name="F:PacketDotNet.IPv6Fields.VersionTrafficClassFlowLabelLength">
<summary>
The IP Version, Traffic Class, and Flow Label field length. These must be in one
field due to boundary crossings.
</summary>
</member>
<member name="F:PacketDotNet.IPv6Fields.PayloadLengthLength">
<summary>
The payload length field length.
</summary>
</member>
<member name="F:PacketDotNet.IPv6Fields.NextHeaderLength">
<summary>
The next header field length, identifies protocol encapsulated by the packet
</summary>
</member>
<member name="F:PacketDotNet.IPv6Fields.HopLimitLength">
<summary>
The hop limit field length.
</summary>
</member>
<member name="F:PacketDotNet.IPv6Fields.AddressLength">
<summary>
Address field length
</summary>
</member>
<member name="F:PacketDotNet.IPv6Fields.VersionTrafficClassFlowLabelPosition">
<summary>
The byte position of the field line in the IPv6 header.
This is where the IP version, Traffic Class, and Flow Label fields are.
</summary>
</member>
<member name="F:PacketDotNet.IPv6Fields.PayloadLengthPosition">
<summary>
The byte position of the payload length field.
</summary>
</member>
<member name="F:PacketDotNet.IPv6Fields.NextHeaderPosition">
<summary>
The byte position of the next header field. (Replaces the ipv4 protocol field)
</summary>
</member>
<member name="F:PacketDotNet.IPv6Fields.HopLimitPosition">
<summary>
The byte position of the hop limit field.
</summary>
</member>
<member name="F:PacketDotNet.IPv6Fields.SourceAddressPosition">
<summary>
The byte position of the source address field.
</summary>
</member>
<member name="F:PacketDotNet.IPv6Fields.DestinationAddressPosition">
<summary>
The byte position of the destination address field.
</summary>
</member>
<member name="F:PacketDotNet.IPv6Fields.HeaderLength">
<summary>
The byte length of the IPv6 Header
</summary>
</member>
<member name="T:PacketDotNet.IPv6Packet">
<summary>
IPv6 packet
References
----------
http://tools.ietf.org/html/rfc2460
http://en.wikipedia.org/wiki/IPv6
</summary>
</member>
<member name="M:PacketDotNet.IPv6Packet.#ctor(System.Net.IPAddress,System.Net.IPAddress)">
<summary>
Create an IPv6 packet from values
</summary>
<param name="SourceAddress">
A <see cref="T:System.Net.IPAddress" /></param>
<param name="DestinationAddress">
A <see cref="T:System.Net.IPAddress" /></param>
</member>
<member name="M:PacketDotNet.IPv6Packet.#ctor(PacketDotNet.Utils.ByteArraySegment)">
<summary>
Constructor
</summary>
<param name="bas">
A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
</member>
<member name="F:PacketDotNet.IPv6Packet.HeaderMinimumLength">
<value>
Minimum number of bytes in an IPv6 header
</value>
</member>
<member name="F:PacketDotNet.IPv6Packet.ipVersion">
<value>
The version of the IP protocol. The '6' in IPv6 indicates the version of the protocol
</value>
</member>
<member name="P:PacketDotNet.IPv6Packet.Version">
<summary>
The version field of the IPv6 Packet.
</summary>
</member>
<member name="P:PacketDotNet.IPv6Packet.TrafficClass">
<summary>
The traffic class field of the IPv6 Packet.
</summary>
</member>
<member name="P:PacketDotNet.IPv6Packet.FlowLabel">
<summary>
The flow label field of the IPv6 Packet.
</summary>
</member>
<member name="P:PacketDotNet.IPv6Packet.PayloadLength">
<summary>
The payload lengeth field of the IPv6 Packet
NOTE: Differs from the IPv4 'Total length' field that includes the length of the header as
payload length is ONLY the size of the payload.
</summary>
</member>
<member name="P:PacketDotNet.IPv6Packet.HeaderLength">
<value>
Backwards compatibility property for IPv4.HeaderLength
NOTE: This field is the number of 32bit words
</value>
</member>
<member name="P:PacketDotNet.IPv6Packet.TotalLength">
<value>
Backwards compatibility property for IPv4.TotalLength
</value>
</member>
<member name="P:PacketDotNet.IPv6Packet.NextHeader">
<summary>
Identifies the protocol encapsulated by this packet
Replaces IPv4's 'protocol' field, has compatible values
</summary>
</member>
<member name="P:PacketDotNet.IPv6Packet.Protocol">
<value>
The protocol of the packet encapsulated in this ip packet
</value>
</member>
<member name="P:PacketDotNet.IPv6Packet.HopLimit">
<summary>
The hop limit field of the IPv6 Packet.
NOTE: Replaces the 'time to live' field of IPv4
8-bit value
</summary>
</member>
<member name="P:PacketDotNet.IPv6Packet.TimeToLive">
<value>
Helper alias for 'HopLimit'
</value>
</member>
<member name="P:PacketDotNet.IPv6Packet.SourceAddress">
<summary>
The source address field of the IPv6 Packet.
</summary>
</member>
<member name="P:PacketDotNet.IPv6Packet.DestinationAddress">
<summary>
The destination address field of the IPv6 Packet.
</summary>
</member>
<member name="P:PacketDotNet.IPv6Packet.Color">
<summary> Fetch ascii escape sequence of the color associated with this packet type.</summary>
</member>
<member name="M:PacketDotNet.IPv6Packet.AttachPseudoIPHeader(System.Byte[])">
<summary>
Prepend to the given byte[] origHeader the portion of the IPv6 header used for
generating an tcp checksum
http://en.wikipedia.org/wiki/Transmission_Control_Protocol#TCP_checksum_using_IPv6
http://tools.ietf.org/html/rfc2460#page-27
</summary>
<param name="origHeader">
A <see cref="T:System.Byte" /></param>
<returns>
A <see cref="T:System.Byte" /></returns>
</member>
<member name="M:PacketDotNet.IPv6Packet.ToString(PacketDotNet.StringOutputType)">
<summary cref="Packet.ToString(StringOutputType)" />
</member>
<member name="M:PacketDotNet.IPv6Packet.RandomPacket">
<summary>
Generate a random packet
</summary>
<returns>
A <see cref="T:PacketDotNet.Packet" /></returns>
</member>
<member name="T:PacketDotNet.IpPort">
<summary> Code constants for ip ports. </summary>
</member>
<member name="F:PacketDotNet.IpPort.Ssh">
<summary>
Secure shell
</summary>
</member>
<member name="F:PacketDotNet.IpPort.Telnet">
<summary>
Terminal protocol
</summary>
</member>
<member name="F:PacketDotNet.IpPort.Smtp">
<summary>
Simple mail transport protocol
</summary>
</member>
<member name="F:PacketDotNet.IpPort.Http">
<summary>
Hyper text transfer protocol
</summary>
</member>
<member name="F:PacketDotNet.IpPort.Www">
<summary>
Same as Http
</summary>
</member>
<member name="F:PacketDotNet.IpPort.Sftp">
<summary>
Secure ftp
</summary>
</member>
<member name="F:PacketDotNet.IpPort.Ntp">
<summary>
Network time protocol
</summary>
</member>
<member name="F:PacketDotNet.IpPort.Snmp">
<summary>
Simple network management protocol
</summary>
</member>
<member name="T:PacketDotNet.Utils.ChecksumUtils">
<summary>
Computes the one's sum on a byte array.
Based TCP/IP Illustrated Vol. 2(1995) by Gary R. Wright and W. Richard
Stevens. Page 236. And on http://www.cs.utk.edu/~cs594np/unp/checksum.html
</summary>
</member>
<member name="M:PacketDotNet.Utils.ChecksumUtils.OnesComplementSum(System.Byte[])">
<summary>
Computes the one's complement sum on a byte array
</summary>
</member>
<member name="M:PacketDotNet.Utils.ChecksumUtils.OnesComplementSum(System.Byte[],System.Int32,System.Int32)">
<summary>
Computes the one's complement sum on a byte array
</summary>
</member>
<member name="M:PacketDotNet.Utils.ChecksumUtils.OnesSum(System.Byte[])">
<summary>
Compute a ones sum of a byte array
</summary>
<param name="bytes">
A <see cref="T:System.Byte" /></param>
<returns>
A <see cref="T:System.Int32" /></returns>
</member>
<member name="M:PacketDotNet.Utils.ChecksumUtils.OnesSum(System.Byte[],System.Int32,System.Int32)">
<summary>
16 bit sum of all values
http://en.wikipedia.org/wiki/Signed_number_representations#Ones.27_complement
</summary>
<param name="bytes">
A <see cref="T:System.Byte" /></param>
<param name="start">
A <see cref="T:System.Int32" /></param>
<param name="len">
A <see cref="T:System.Int32" /></param>
<returns>
A <see cref="T:System.Int32" /></returns>
</member>
<member name="T:PacketDotNet.TcpFields">
<summary> IP protocol field encoding information.
</summary>
</member>
<member name="F:PacketDotNet.TcpFields.PortLength">
<summary> Length of a TCP port in bytes.</summary>
</member>
<member name="F:PacketDotNet.TcpFields.SequenceNumberLength">
<summary> Length of the sequence number in bytes.</summary>
</member>
<member name="F:PacketDotNet.TcpFields.AckNumberLength">
<summary> Length of the acknowledgment number in bytes.</summary>
</member>
<member name="F:PacketDotNet.TcpFields.DataOffsetLength">
<summary> Length of the data offset and flags field in bytes.</summary>
</member>
<member name="F:PacketDotNet.TcpFields.FlagsLength">
<summary> The length of the flags field </summary>
</member>
<member name="F:PacketDotNet.TcpFields.WindowSizeLength">
<summary> Length of the window size field in bytes.</summary>
</member>
<member name="F:PacketDotNet.TcpFields.ChecksumLength">
<summary> Length of the checksum field in bytes.</summary>
</member>
<member name="F:PacketDotNet.TcpFields.UrgentPointerLength">
<summary> Length of the urgent field in bytes.</summary>
</member>
<member name="F:PacketDotNet.TcpFields.SourcePortPosition">
<summary> Position of the source port field.</summary>
</member>
<member name="F:PacketDotNet.TcpFields.DestinationPortPosition">
<summary> Position of the destination port field.</summary>
</member>
<member name="F:PacketDotNet.TcpFields.SequenceNumberPosition">
<summary> Position of the sequence number field.</summary>
</member>
<member name="F:PacketDotNet.TcpFields.AckNumberPosition">
<summary> Position of the acknowledgment number field.</summary>
</member>
<member name="F:PacketDotNet.TcpFields.DataOffsetPosition">
<summary> Position of the data offset </summary>
</member>
<member name="F:PacketDotNet.TcpFields.FlagsPosition">
<summary> Position of the flags field </summary>
</member>
<member name="F:PacketDotNet.TcpFields.WindowSizePosition">
<summary> Position of the window size field.</summary>
</member>
<member name="F:PacketDotNet.TcpFields.ChecksumPosition">
<summary> Position of the checksum field.</summary>
</member>
<member name="F:PacketDotNet.TcpFields.UrgentPointerPosition">
<summary> Position of the urgent pointer field.</summary>
</member>
<member name="F:PacketDotNet.TcpFields.HeaderLength">
<summary> Length in bytes of a TCP header.</summary>
</member>
<member name="T:PacketDotNet.ARPFields">
<summary> IP protocol field encoding information.
</summary>
FIXME: These fields are partially broken because they assume the offset for
several fields and the offset is actually based on the accumulated offset
into the structure determined by the fields that indicate sizes</member>
<member name="F:PacketDotNet.ARPFields.EthernetProtocolType">
<summary> Type code for ethernet addresses.</summary>
</member>
<member name="F:PacketDotNet.ARPFields.IPv4ProtocolType">
<summary> Type code for MAC addresses.</summary>
</member>
<member name="F:PacketDotNet.ARPFields.OperationLength">
<summary> Operation type length in bytes.</summary>
</member>
<member name="F:PacketDotNet.ARPFields.AddressTypeLength">
<summary>
The length of the address type fields in bytes,
eg. the length of hardware type or protocol type
</summary>
</member>
<member name="F:PacketDotNet.ARPFields.AddressLengthLength">
<summary>
The length of the address length fields in bytes.
</summary>
</member>
<member name="F:PacketDotNet.ARPFields.HardwareAddressTypePosition">
<summary> Position of the hardware address type.</summary>
</member>
<member name="F:PacketDotNet.ARPFields.ProtocolAddressTypePosition">
<summary> Position of the protocol address type.</summary>
</member>
<member name="F:PacketDotNet.ARPFields.HardwareAddressLengthPosition">
<summary> Position of the hardware address length.</summary>
</member>
<member name="F:PacketDotNet.ARPFields.ProtocolAddressLengthPosition">
<summary> Position of the protocol address length.</summary>
</member>
<member name="F:PacketDotNet.ARPFields.OperationPosition">
<summary> Position of the operation type.</summary>
</member>
<member name="F:PacketDotNet.ARPFields.SenderHardwareAddressPosition">
<summary> Position of the sender hardware address.</summary>
</member>
<member name="F:PacketDotNet.ARPFields.SenderProtocolAddressPosition">
<summary> Position of the sender protocol address.</summary>
</member>
<member name="F:PacketDotNet.ARPFields.TargetHardwareAddressPosition">
<summary> Position of the target hardware address.</summary>
</member>
<member name="F:PacketDotNet.ARPFields.TargetProtocolAddressPosition">
<summary> Position of the target protocol address.</summary>
</member>
<member name="F:PacketDotNet.ARPFields.HeaderLength">
<summary> Total length in bytes of an ARP header.</summary>
</member>
<member name="T:PacketDotNet.ARPPacket">
<summary>
An ARP protocol packet.
</summary>
</member>
<member name="M:PacketDotNet.ARPPacket.#ctor(PacketDotNet.ARPOperation,System.Net.NetworkInformation.PhysicalAddress,System.Net.IPAddress,System.Net.NetworkInformation.PhysicalAddress,System.Net.IPAddress)">
<summary>
Create an ARPPacket from values
</summary>
<param name="Operation">
A <see cref="T:PacketDotNet.ARPOperation" /></param>
<param name="TargetHardwareAddress">
A <see cref="T:System.Net.NetworkInformation.PhysicalAddress" /></param>
<param name="TargetProtocolAddress">
A <see cref="T:System.Net.IPAddress" /></param>
<param name="SenderHardwareAddress">
A <see cref="T:System.Net.NetworkInformation.PhysicalAddress" /></param>
<param name="SenderProtocolAddress">
A <see cref="T:System.Net.IPAddress" /></param>
</member>
<member name="M:PacketDotNet.ARPPacket.#ctor(PacketDotNet.Utils.ByteArraySegment)">
<summary>
Constructor
</summary>
<param name="bas">
A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
</member>
<member name="P:PacketDotNet.ARPPacket.HardwareAddressType">
<value>
Also known as HardwareType
</value>
</member>
<member name="P:PacketDotNet.ARPPacket.ProtocolAddressType">
<value>
Also known as ProtocolType
</value>
</member>
<member name="P:PacketDotNet.ARPPacket.HardwareAddressLength">
<value>
Hardware address length field
</value>
</member>
<member name="P:PacketDotNet.ARPPacket.ProtocolAddressLength">
<value>
Protocol address length field
</value>
</member>
<member name="P:PacketDotNet.ARPPacket.Operation">
<summary> Fetch the operation code.
Usually one of ARPFields.{ARP_OP_REQ_CODE, ARP_OP_REP_CODE}.
</summary>
<summary> Sets the operation code.
Usually one of ARPFields.{ARP_OP_REQ_CODE, ARP_OP_REP_CODE}.
</summary>
</member>
<member name="P:PacketDotNet.ARPPacket.SenderProtocolAddress">
<value>
Upper layer protocol address of the sender, arp is used for IPv4, IPv6 uses NDP
</value>
</member>
<member name="P:PacketDotNet.ARPPacket.TargetProtocolAddress">
<value>
Upper layer protocol address of the target, arp is used for IPv4, IPv6 uses NDP
</value>
</member>
<member name="P:PacketDotNet.ARPPacket.SenderHardwareAddress">
<value>
Sender hardware address, usually an ethernet mac address
</value>
</member>
<member name="P:PacketDotNet.ARPPacket.TargetHardwareAddress">
<value>
Target hardware address, usually an ethernet mac address
</value>
</member>
<member name="P:PacketDotNet.ARPPacket.Color">
<summary> Fetch ascii escape sequence of the color associated with this packet type.</summary>
</member>
<member name="M:PacketDotNet.ARPPacket.ToString(PacketDotNet.StringOutputType)">
<summary cref="Packet.ToString(StringOutputType)" />
</member>
<member name="M:PacketDotNet.ARPPacket.GetEncapsulated(PacketDotNet.Packet)">
<summary>
Returns the encapsulated ARPPacket of the Packet p or null if
there is no encapsulated packet
</summary>
<param name="p">
A <see cref="T:PacketDotNet.Packet" /></param>
<returns>
A <see cref="T:PacketDotNet.ARPPacket" /></returns>
</member>
<member name="T:PacketDotNet.ICMPv6Fields">
<summary>
ICMP protocol field encoding information.
See http://en.wikipedia.org/wiki/ICMPv6
</summary>
</member>
<member name="F:PacketDotNet.ICMPv6Fields.TypeLength">
<summary> Length of the ICMP message type code in bytes.</summary>
</member>
<member name="F:PacketDotNet.ICMPv6Fields.CodeLength">
<summary> Length of the ICMP subcode in bytes.</summary>
</member>
<member name="F:PacketDotNet.ICMPv6Fields.ChecksumLength">
<summary> Length of the ICMP header checksum in bytes.</summary>
</member>
<member name="F:PacketDotNet.ICMPv6Fields.TypePosition">
<summary> Position of the ICMP message type.</summary>
</member>
<member name="F:PacketDotNet.ICMPv6Fields.CodePosition">
<summary> Position of the ICMP message subcode.</summary>
</member>
<member name="F:PacketDotNet.ICMPv6Fields.ChecksumPosition">
<summary> Position of the ICMP header checksum.</summary>
</member>
<member name="F:PacketDotNet.ICMPv6Fields.HeaderLength">
<summary> Length in bytes of an ICMP header.</summary>
</member>
<member name="T:PacketDotNet.ICMPv6Packet">
<summary>
An ICMP packet.
See http://en.wikipedia.org/wiki/ICMPv6
</summary>
</member>
<member name="M:PacketDotNet.ICMPv6Packet.#ctor(PacketDotNet.Utils.ByteArraySegment)">
<summary>
Constructor
</summary>
<param name="bas">
A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
</member>
<member name="M:PacketDotNet.ICMPv6Packet.#ctor(PacketDotNet.Utils.ByteArraySegment,PacketDotNet.Packet)">
<summary>
Constructor with parent packet
</summary>
<param name="bas">
A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
<param name="ParentPacket">
A <see cref="T:PacketDotNet.Packet" /></param>
</member>
<member name="F:PacketDotNet.ICMPv6Packet.skipUpdating">
<summary>
Used to prevent a recursive stack overflow
when recalculating in UpdateCalculatedValues()
</summary>
</member>
<member name="P:PacketDotNet.ICMPv6Packet.Type">
<value>
The Type value
</value>
</member>
<member name="P:PacketDotNet.ICMPv6Packet.Code">
<summary> Fetch the ICMP code </summary>
</member>
<member name="P:PacketDotNet.ICMPv6Packet.Checksum">
<value>
Checksum value
</value>
</member>
<member name="P:PacketDotNet.ICMPv6Packet.Color">
<summary> Fetch ascii escape sequence of the color associated with this packet type.</summary>
</member>
<member name="M:PacketDotNet.ICMPv6Packet.UpdateCalculatedValues">
<summary>
Recalculate the checksum
</summary>
</member>
<member name="M:PacketDotNet.ICMPv6Packet.ToString(PacketDotNet.StringOutputType)">
<summary cref="Packet.ToString(StringOutputType)" />
</member>
<member name="M:PacketDotNet.ICMPv6Packet.GetEncapsulated(PacketDotNet.Packet)">
<summary>
Returns the ICMPv6Packet inside of Packet p or null if
there is no encapsulated ICMPv6Packet
</summary>
<param name="p">
A <see cref="T:PacketDotNet.Packet" /></param>
<returns>
A <see cref="T:PacketDotNet.ICMPv6Packet" /></returns>
</member>
<member name="T:PacketDotNet.IGMPMessageType">
<summary> Code constants for IGMP message types.
From RFC #2236.
</summary>
</member>
<member name="T:PacketDotNet.IGMPv2Packet">
<summary>
An IGMP packet.
</summary>
</member>
<member name="M:PacketDotNet.IGMPv2Packet.#ctor(PacketDotNet.Utils.ByteArraySegment)">
<summary>
Constructor
</summary>
<param name="bas">
A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
</member>
<member name="M:PacketDotNet.IGMPv2Packet.#ctor(PacketDotNet.Utils.ByteArraySegment,PacketDotNet.Packet)">
<summary>
Constructor with parent
</summary>
<param name="bas">
A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
<param name="ParentPacket">
A <see cref="T:PacketDotNet.Packet" /></param>
</member>
<member name="P:PacketDotNet.IGMPv2Packet.Type">
<value>
The type of IGMP message
</value>
</member>
<member name="P:PacketDotNet.IGMPv2Packet.MaxResponseTime">
<summary> Fetch the IGMP max response time.</summary>
</member>
<member name="P:PacketDotNet.IGMPv2Packet.Checksum">
<summary> Fetch the IGMP header checksum.</summary>
</member>
<member name="P:PacketDotNet.IGMPv2Packet.GroupAddress">
<summary> Fetch the IGMP group address.</summary>
</member>
<member name="P:PacketDotNet.IGMPv2Packet.Color">
<summary> Fetch ascii escape sequence of the color associated with this packet type.</summary>
</member>
<member name="M:PacketDotNet.IGMPv2Packet.GetEncapsulated(PacketDotNet.Packet)">
<summary>
Returns the encapsulated IGMPv2Packet of the Packet p or null if
there is no encapsulated packet
</summary>
<param name="p">
A <see cref="T:PacketDotNet.Packet" /></param>
<returns>
A <see cref="T:PacketDotNet.IGMPv2Packet" /></returns>
</member>
<member name="M:PacketDotNet.IGMPv2Packet.ToString(PacketDotNet.StringOutputType)">
<summary cref="Packet.ToString(StringOutputType)" />
</member>
<member name="T:PacketDotNet.InternetLinkLayerPacket">
<summary>
Internet Link layer packet
See http://en.wikipedia.org/wiki/Link_Layer
</summary>
</member>
<member name="M:PacketDotNet.InternetLinkLayerPacket.#ctor">
<summary>
Constructor
</summary>
</member>
<member name="M:PacketDotNet.InternetLinkLayerPacket.GetInnerPayload(PacketDotNet.InternetLinkLayerPacket)">
<summary>
Look for the innermost payload. This method is useful because
while some packets are LinuxSSL->IpPacket or
EthernetPacket->IpPacket, there are some packets that are
EthernetPacket->PPPoEPacket->PPPPacket->IpPacket, and for these cases
we really want to get to the IpPacket
</summary>
<returns>
A <see cref="T:PacketDotNet.Packet" /></returns>
</member>
<member name="T:PacketDotNet.IGMPv2Fields">
<summary> IGMP protocol field encoding information. </summary>
</member>
<member name="F:PacketDotNet.IGMPv2Fields.TypeLength">
<summary> Length of the IGMP message type code in bytes.</summary>
</member>
<member name="F:PacketDotNet.IGMPv2Fields.MaxResponseTimeLength">
<summary> Length of the IGMP max response code in bytes.</summary>
</member>
<member name="F:PacketDotNet.IGMPv2Fields.ChecksumLength">
<summary> Length of the IGMP header checksum in bytes.</summary>
</member>
<member name="F:PacketDotNet.IGMPv2Fields.GroupAddressLength">
<summary> Length of group address in bytes.</summary>
</member>
<member name="F:PacketDotNet.IGMPv2Fields.TypePosition">
<summary> Position of the IGMP message type.</summary>
</member>
<member name="F:PacketDotNet.IGMPv2Fields.MaxResponseTimePosition">
<summary> Position of the IGMP max response code.</summary>
</member>
<member name="F:PacketDotNet.IGMPv2Fields.ChecksumPosition">
<summary> Position of the IGMP header checksum.</summary>
</member>
<member name="F:PacketDotNet.IGMPv2Fields.GroupAddressPosition">
<summary> Position of the IGMP group address.</summary>
</member>
<member name="F:PacketDotNet.IGMPv2Fields.HeaderLength">
<summary> Length in bytes of an IGMP header.</summary>
</member>
<member name="T:PacketDotNet.LinuxSLLPacket">
<summary>
Represents a Linux cooked capture packet, the kinds of packets
received when capturing on an 'any' device
See http://github.com/mcr/libpcap/blob/master/pcap/sll.h
</summary>
</member>
<member name="M:PacketDotNet.LinuxSLLPacket.#ctor(PacketDotNet.Utils.ByteArraySegment)">
<summary>
Constructor
</summary>
<param name="bas">
A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
</member>
<member name="P:PacketDotNet.LinuxSLLPacket.Type">
<value>
Information about the packet direction
</value>
</member>
<member name="P:PacketDotNet.LinuxSLLPacket.LinkLayerAddressType">
<value>
The
</value>
</member>
<member name="P:PacketDotNet.LinuxSLLPacket.LinkLayerAddressLength">
<value>
Number of bytes in the link layer address of the sender of the packet
</value>
</member>
<member name="P:PacketDotNet.LinuxSLLPacket.LinkLayerAddress">
<value>
Link layer header bytes, maximum of 8 bytes
</value>
</member>
<member name="P:PacketDotNet.LinuxSLLPacket.EthernetProtocolType">
<value>
The encapsulated protocol type
</value>
</member>
<member name="M:PacketDotNet.LinuxSLLPacket.ToString(PacketDotNet.StringOutputType)">
<summary cref="Packet.ToString(StringOutputType)" />
</member>
<member name="T:PacketDotNet.LinuxSLLFields">
<summary>
Lengths and offsets to the fields in the LinuxSLL packet
See http://github.com/mcr/libpcap/blob/master/pcap/sll.h
</summary>
</member>
<member name="F:PacketDotNet.LinuxSLLFields.PacketTypeLength">
<summary>
Length of the packet type field
</summary>
</member>
<member name="F:PacketDotNet.LinuxSLLFields.LinkLayerAddressTypeLength">
<summary>
Link layer address type
</summary>
</member>
<member name="F:PacketDotNet.LinuxSLLFields.LinkLayerAddressLengthLength">
<summary>
Link layer address length
</summary>
</member>
<member name="F:PacketDotNet.LinuxSLLFields.LinkLayerAddressMaximumLength">
<summary>
The link layer address field length
NOTE: the actual link layer address MAY be shorter than this
</summary>
</member>
<member name="F:PacketDotNet.LinuxSLLFields.SLLHeaderLength">
<summary>
Number of bytes in a SLL header
</summary>
</member>
<member name="F:PacketDotNet.LinuxSLLFields.EthernetProtocolTypeLength">
<summary>
Length of the ethernet protocol field
</summary>
</member>
<member name="F:PacketDotNet.LinuxSLLFields.PacketTypePosition">
<summary>
Position of the packet type field
</summary>
</member>
<member name="F:PacketDotNet.LinuxSLLFields.LinkLayerAddressTypePosition">
<summary>
Position of the link layer address type field
</summary>
</member>
<member name="F:PacketDotNet.LinuxSLLFields.LinkLayerAddressLengthPosition">
<summary>
Positino of the link layer address length field
</summary>
</member>
<member name="F:PacketDotNet.LinuxSLLFields.LinkLayerAddressPosition">
<summary>
Position of the link layer address field
</summary>
</member>
<member name="F:PacketDotNet.LinuxSLLFields.EthernetProtocolTypePosition">
<summary>
Position of the ethernet protocol type field
</summary>
</member>
<member name="T:PacketDotNet.LinuxSLLType">
<summary>
The types of cooked packets
See http://github.com/mcr/libpcap/blob/master/pcap/sll.h
</summary>
</member>
<member name="F:PacketDotNet.LinuxSLLType.PacketSentToUs">
<summary>
Packet was sent to us by somebody else
</summary>
</member>
<member name="F:PacketDotNet.LinuxSLLType.PacketBroadCast">
<summary>
Packet was broadcast by somebody else
</summary>
</member>
<member name="F:PacketDotNet.LinuxSLLType.PacketMulticast">
<summary>
Packet was multicast, but not broadcast
</summary>
</member>
<member name="F:PacketDotNet.LinuxSLLType.PacketSentToSomeoneElse">
<summary>
Packet was sent by somebody else to somebody else
</summary>
</member>
<member name="F:PacketDotNet.LinuxSLLType.PacketSentByUs">
<summary>
Packet was sent by us
</summary>
</member>
<member name="T:PacketDotNet.IPProtocolType">
<summary>
The protocol encapsulated inside of the IP packet
</summary>
</member>
<member name="F:PacketDotNet.IPProtocolType.IP">
<summary> Dummy protocol for TCP. </summary>
</member>
<member name="F:PacketDotNet.IPProtocolType.HOPOPTS">
<summary> IPv6 Hop-by-Hop options. </summary>
</member>
<member name="F:PacketDotNet.IPProtocolType.ICMP">
<summary> Internet Control Message Protocol. </summary>
</member>
<member name="F:PacketDotNet.IPProtocolType.IGMP">
<summary> Internet Group Management Protocol.</summary>
</member>
<member name="F:PacketDotNet.IPProtocolType.IPIP">
<summary> IPIP tunnels (older KA9Q tunnels use 94). </summary>
</member>
<member name="F:PacketDotNet.IPProtocolType.TCP">
<summary> Transmission Control Protocol. </summary>
</member>
<member name="F:PacketDotNet.IPProtocolType.EGP">
<summary> Exterior Gateway Protocol. </summary>
</member>
<member name="F:PacketDotNet.IPProtocolType.PUP">
<summary> PUP protocol. </summary>
</member>
<member name="F:PacketDotNet.IPProtocolType.UDP">
<summary> User Datagram Protocol. </summary>
</member>
<member name="F:PacketDotNet.IPProtocolType.IDP">
<summary> XNS IDP protocol. </summary>
</member>
<member name="F:PacketDotNet.IPProtocolType.TP">
<summary> SO Transport Protocol Class 4. </summary>
</member>
<member name="F:PacketDotNet.IPProtocolType.IPV6">
<summary> IPv6 header. </summary>
</member>
<member name="F:PacketDotNet.IPProtocolType.ROUTING">
<summary> IPv6 routing header. </summary>
</member>
<member name="F:PacketDotNet.IPProtocolType.FRAGMENT">
<summary> IPv6 fragmentation header. </summary>
</member>
<member name="F:PacketDotNet.IPProtocolType.RSVP">
<summary> Reservation Protocol. </summary>
</member>
<member name="F:PacketDotNet.IPProtocolType.GRE">
<summary> General Routing Encapsulation. </summary>
</member>
<member name="F:PacketDotNet.IPProtocolType.ESP">
<summary> encapsulating security payload. </summary>
</member>
<member name="F:PacketDotNet.IPProtocolType.AH">
<summary> authentication header. </summary>
</member>
<member name="F:PacketDotNet.IPProtocolType.ICMPV6">
<summary> ICMPv6. </summary>
</member>
<member name="F:PacketDotNet.IPProtocolType.NONE">
<summary> IPv6 no next header. </summary>
</member>
<member name="F:PacketDotNet.IPProtocolType.DSTOPTS">
<summary> IPv6 destination options. </summary>
</member>
<member name="F:PacketDotNet.IPProtocolType.MTP">
<summary> Multicast Transport Protocol. </summary>
</member>
<member name="F:PacketDotNet.IPProtocolType.ENCAP">
<summary> Encapsulation Header. </summary>
</member>
<member name="F:PacketDotNet.IPProtocolType.PIM">
<summary> Protocol Independent Multicast. </summary>
</member>
<member name="F:PacketDotNet.IPProtocolType.COMP">
<summary> Compression Header Protocol. </summary>
</member>
<member name="F:PacketDotNet.IPProtocolType.RAW">
<summary> Raw IP packets. </summary>
</member>
<member name="F:PacketDotNet.IPProtocolType.MASK">
<summary> IP protocol mask.</summary>
</member>
<member name="T:PacketDotNet.IpVersion">
<summary> Code constants for internet protocol versions.
</summary>
</member>
<member name="F:PacketDotNet.IpVersion.IPv4">
<summary> Internet protocol version 4.</summary>
</member>
<member name="F:PacketDotNet.IpVersion.IPv6">
<summary> Internet protocol version 6.</summary>
</member>
<member name="T:PacketDotNet.LinkLayers">
<summary> Link-layer type codes.
<p>
Taken from libpcap/bpf/net/bpf.h and pcap/net/bpf.h.
</p><p>
The link-layer type is used to determine what data-structure the
IP protocol bits will be encapsulated inside of.
</p><p>
On a 10/100mbps network, packets are encapsulated inside of ethernet.
14-byte ethernet headers which contain MAC addresses and an ethernet type
field.
</p><p>
On ethernet over ppp, the link-layer type is raw, and packets
are not encapsulated in any ethernet header.
</p></summary>
</member>
<member name="F:PacketDotNet.LinkLayers.Null">
<summary> no link-layer encapsulation </summary>
</member>
<member name="F:PacketDotNet.LinkLayers.Ethernet">
<summary> Ethernet (10Mb) </summary>
</member>
<member name="F:PacketDotNet.LinkLayers.ExperimentalEthernet3MB">
<summary> Experimental Ethernet (3Mb) </summary>
</member>
<member name="F:PacketDotNet.LinkLayers.AmateurRadioAX25">
<summary> Amateur Radio AX.25 </summary>
</member>
<member name="F:PacketDotNet.LinkLayers.ProteonProNetTokenRing">
<summary> Proteon ProNET Token Ring </summary>
</member>
<member name="F:PacketDotNet.LinkLayers.Chaos">
<summary> Chaos </summary>
</member>
<member name="F:PacketDotNet.LinkLayers.Ieee802">
<summary> IEEE 802 Networks </summary>
</member>
<member name="F:PacketDotNet.LinkLayers.ArcNet">
<summary> ARCNET </summary>
</member>
<member name="F:PacketDotNet.LinkLayers.Slip">
<summary> Serial Line IP </summary>
</member>
<member name="F:PacketDotNet.LinkLayers.Ppp">
<summary> Point-to-point Protocol </summary>
</member>
<member name="F:PacketDotNet.LinkLayers.Fddi">
<summary> FDDI </summary>
</member>
<member name="F:PacketDotNet.LinkLayers.AtmRfc1483">
<summary> LLC/SNAP encapsulated atm </summary>
</member>
<member name="F:PacketDotNet.LinkLayers.Raw">
<summary> raw IP </summary>
</member>
<member name="F:PacketDotNet.LinkLayers.SlipBSD">
<summary> BSD Slip.</summary>
</member>
<member name="F:PacketDotNet.LinkLayers.PppBSD">
<summary> BSD PPP.</summary>
</member>
<member name="F:PacketDotNet.LinkLayers.AtmClip">
<summary> IP over ATM.</summary>
</member>
<member name="F:PacketDotNet.LinkLayers.PppSerial">
<summary> PPP over HDLC.</summary>
</member>
<member name="F:PacketDotNet.LinkLayers.CiscoHDLC">
<summary> Cisco HDLC.</summary>
</member>
<member name="F:PacketDotNet.LinkLayers.Ieee80211">
<summary> IEEE 802.11 wireless.</summary>
</member>
<member name="F:PacketDotNet.LinkLayers.Loop">
<summary> OpenBSD loopback.</summary>
</member>
<member name="F:PacketDotNet.LinkLayers.LinuxSLL">
<summary> Linux cooked sockets.</summary>
</member>
<member name="F:PacketDotNet.LinkLayers.Ieee80211_Radio">
<summary>
Header for 802.11 plus a number of bits of link-layer information
including radio information, used by some recent BSD drivers as
well as the madwifi Atheros driver for Linux.
</summary>
</member>
<member name="F:PacketDotNet.LinkLayers.PerPacketInformation">
<summary>
Per Packet Information encapsulated packets.
DLT_ requested by Gianluca Varenni <gianluca.varenni@cacetech.com>.
See http://www.cacetech.com/documents/PPI%20Header%20format%201.0.7.pdf
</summary>
</member>
<member name="T:PacketDotNet.Utils.HexPrinter">
<summary>
Helper class that prints out an array of hex values
</summary>
</member>
<member name="M:PacketDotNet.Utils.HexPrinter.GetString(System.Byte[],System.Int32,System.Int32)">
<summary>
Create a string that contains the hex values of byte[] Byte in
text form
</summary>
<param name="Byte">
A <see cref="T:System.Byte" /></param>
<param name="Offset">
A <see cref="T:System.Int32" /></param>
<param name="Length">
A <see cref="T:System.Int32" /></param>
<returns>
A <see cref="T:System.String" /></returns>
</member>
<member name="M:PacketDotNet.Utils.HexPrinter.PrintMACAddress(System.Net.NetworkInformation.PhysicalAddress)">
<summary>
Creates a string from a Physical address in the format "xx:xx:xx:xx:xx:xx"
</summary>
<param name="address">
A <see cref="T:System.Net.NetworkInformation.PhysicalAddress" /></param>
<returns>
A <see cref="T:System.String" /></returns>
</member>
<member name="T:PacketDotNet.Utils.RandomUtils">
<summary>
Random utility methods
</summary>
</member>
<member name="M:PacketDotNet.Utils.RandomUtils.GetIPAddress(PacketDotNet.IpVersion)">
<summary>
Generate a random ip address
</summary>
<param name="version">
A <see cref="T:PacketDotNet.IpVersion" /></param>
<returns>
A <see cref="T:System.Net.IPAddress" /></returns>
</member>
<!--FIXME: Invalid documentation markup was found for member M:PacketDotNet.Utils.RandomUtils.LongestStringLength(System.Collections.Generic.List{System.String})-->
<member name="T:PacketDotNet.PayloadType">
<summary>
Differentiates between a packet class payload, a byte[] payload
or no payload
</summary>
</member>
<member name="T:PacketDotNet.ICMPv6Types">
<summary>
ICMPv6 types, see http://en.wikipedia.org/wiki/ICMPv6 and
http://www.iana.org/assignments/icmpv6-parameters
</summary>
</member>
<member name="T:PacketDotNet.ARPOperation">
<summary>
The possible ARP operation values
</summary>
<remarks>
References:
- http://www.networksorcery.com/enp/default1101.htm
</remarks>
</member>
<member name="F:PacketDotNet.ARPOperation.Request">
<summary>Request</summary>
<remarks>See RFC 826, RFC 5227</remarks>
</member>
<member name="F:PacketDotNet.ARPOperation.Response">
<summary>Response</summary>
<remarks>See RFC 826, RFC 1868, RFC 5227</remarks>
</member>
<member name="F:PacketDotNet.ARPOperation.RequestReverse">
<summary>Request Reverse</summary>
<remarks>See RFC 903</remarks>
</member>
<member name="F:PacketDotNet.ARPOperation.ReplyReverse">
<summary>Reply Reverse</summary>
<remarks>See RFC 903</remarks>
</member>
<member name="F:PacketDotNet.ARPOperation.DRARPRequest">
<summary>DRARP Request</summary>
<remarks>See RFC 1931</remarks>
</member>
<member name="F:PacketDotNet.ARPOperation.DRARPReply">
<summary>DRARP Reply</summary>
<remarks>See RFC 1931</remarks>
</member>
<member name="F:PacketDotNet.ARPOperation.DRARPError">
<summary>DRARP Error</summary>
<remarks>See RFC 1931</remarks>
</member>
<member name="F:PacketDotNet.ARPOperation.InARPRequest">
<summary>InARP Request</summary>
<remarks>See RFC 1293</remarks>
</member>
<member name="F:PacketDotNet.ARPOperation.InARPReply">
<summary>InARP Reply</summary>
<remarks>See RFC 1293</remarks>
</member>
<member name="F:PacketDotNet.ARPOperation.ARPNAK">
<summary>ARP NAK</summary>
<remarks>See RFC 1577</remarks>
</member>
<member name="F:PacketDotNet.ARPOperation.MARSRequest">
<summary>MARS Request</summary>
</member>
<member name="F:PacketDotNet.ARPOperation.MARSMulti">
<summary>MARS Multi</summary>
</member>
<member name="F:PacketDotNet.ARPOperation.MARSMServ">
<summary>MARS MServ</summary>
</member>
<member name="F:PacketDotNet.ARPOperation.MARSJoin">
<summary>MARS Join</summary>
</member>
<member name="F:PacketDotNet.ARPOperation.MARSLeave">
<summary>MARS Leave</summary>
</member>
<member name="F:PacketDotNet.ARPOperation.MARSNAK">
<summary>MARS NAK</summary>
</member>
<member name="F:PacketDotNet.ARPOperation.MARSUnserv">
<summary>MARS Unserv</summary>
</member>
<member name="F:PacketDotNet.ARPOperation.MARSSJoin">
<summary>MARS SJoin</summary>
</member>
<member name="F:PacketDotNet.ARPOperation.MARSSLeave">
<summary>MARS SLeave</summary>
</member>
<member name="F:PacketDotNet.ARPOperation.MARSGrouplistRequest">
<summary>MARS Grouplist Request</summary>
</member>
<member name="F:PacketDotNet.ARPOperation.MARSGrouplistReply">
<summary>MARS Grouplist Reply</summary>
</member>
<member name="F:PacketDotNet.ARPOperation.MARSRedirectMap">
<summary>MARS Redirect Map</summary>
</member>
<member name="F:PacketDotNet.ARPOperation.MaposUnarp">
<summary>MARS UNARP</summary>
<remarks>See RFC 2176</remarks>
</member>
<member name="F:PacketDotNet.ARPOperation.OP_EXP1">
<summary>OP_EXP1</summary>
<remarks>See RFC 5494</remarks>
</member>
<member name="F:PacketDotNet.ARPOperation.OP_EXP2">
<summary>OP_EXP2</summary>
</member>
<member name="T:PacketDotNet.PPPoEPacket">
<summary>
Point to Point Protocol
See http://tools.ietf.org/html/rfc2516
</summary>
</member>
<member name="M:PacketDotNet.PPPoEPacket.#ctor(PacketDotNet.PPPoECode,System.UInt16)">
<summary>
Construct a new PPPoEPacket from source and destination mac addresses
</summary>
</member>
<member name="M:PacketDotNet.PPPoEPacket.#ctor(PacketDotNet.Utils.ByteArraySegment)">
<summary>
Constructor
</summary>
<param name="bas">
A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
</member>
<member name="P:PacketDotNet.PPPoEPacket.Version">
<summary>
PPPoe version, must be 0x1 according to RFC
</summary>
FIXME: This currently outputs the wrong version number</member>
<member name="P:PacketDotNet.PPPoEPacket.Type">
<summary>
Type, must be 0x1 according to RFC
</summary>
</member>
<member name="P:PacketDotNet.PPPoEPacket.Code">
<summary>
</summary>
FIXME: This currently outputs the wrong code</member>
<member name="P:PacketDotNet.PPPoEPacket.SessionId">
<summary>
Session identifier for this PPPoe packet
</summary>
</member>
<member name="P:PacketDotNet.PPPoEPacket.Length">
<summary>
Length of the PPPoe payload, not including the PPPoe header
</summary>
</member>
<member name="P:PacketDotNet.PPPoEPacket.Color">
<summary> Fetch ascii escape sequence of the color associated with this packet type.</summary>
</member>
<member name="M:PacketDotNet.PPPoEPacket.ToString(PacketDotNet.StringOutputType)">
<summary cref="Packet.ToString(StringOutputType)" />
</member>
<member name="M:PacketDotNet.PPPoEPacket.GetEncapsulated(PacketDotNet.Packet)">
<summary>
Returns the encapsulated PPPoE of the Packet p or null if
there is no encapsulated packet
</summary>
<param name="p">
A <see cref="T:PacketDotNet.Packet" /></param>
<returns>
A <see cref="T:PacketDotNet.ARPPacket" /></returns>
</member>
<member name="M:PacketDotNet.PPPoEPacket.RandomPacket">
<summary>
Generate a random PPPoEPacket
</summary>
<returns>
A <see cref="T:PacketDotNet.PPPoEPacket" /></returns>
</member>
<member name="T:PacketDotNet.PPPoEFields">
<summary>
Point to Point Protocol
See http://tools.ietf.org/html/rfc2516
</summary>
</member>
<member name="F:PacketDotNet.PPPoEFields.VersionTypeLength">
<summary> Size in bytes of the version/type field </summary>
</member>
<member name="F:PacketDotNet.PPPoEFields.CodeLength">
<summary> Size in bytes of the code field </summary>
</member>
<member name="F:PacketDotNet.PPPoEFields.SessionIdLength">
<summary> Size in bytes of the SessionId field </summary>
</member>
<member name="F:PacketDotNet.PPPoEFields.LengthLength">
<summary> Size in bytes of the Length field </summary>
</member>
<member name="F:PacketDotNet.PPPoEFields.VersionTypePosition">
<summary> Offset from the start of the header to the version/type field </summary>
</member>
<member name="F:PacketDotNet.PPPoEFields.CodePosition">
<summary> Offset from the start of the header to the Code field </summary>
</member>
<member name="F:PacketDotNet.PPPoEFields.SessionIdPosition">
<summary> Offset from the start of the header to the SessionId field </summary>
</member>
<member name="F:PacketDotNet.PPPoEFields.LengthPosition">
<summary> Offset from the start of the header to the Length field </summary>
</member>
<member name="F:PacketDotNet.PPPoEFields.HeaderLength">
<summary>
Length of the overall PPPoe header
</summary>
</member>
<member name="T:PacketDotNet.PPPoECode">
<summary>
Values for the Code field of a PPPoE packet
See http://tools.ietf.org/html/rfc2516
</summary>
</member>
<member name="F:PacketDotNet.PPPoECode.SessionStage">
<summary>
The PPPoe payload must contain a PPP packet
</summary>
</member>
<member name="F:PacketDotNet.PPPoECode.ActiveDiscoveryOffer">
<summary>
Active Discovery Offer (PADO) packet
</summary>
</member>
<member name="F:PacketDotNet.PPPoECode.ActiveDiscoveryInitiation">
<summary>
From RFC2516:
The Host sends the PADI packet with the DESTINATION_ADDR set to the
broadcast address. The CODE field is set to 0x09 and the SESSION_ID
MUST be set to 0x0000.
The PADI packet MUST contain exactly one TAG of TAG_TYPE Service-
Name, indicating the service the Host is requesting, and any number
of other TAG types. An entire PADI packet (including the PPPoE
header) MUST NOT exceed 1484 octets so as to leave sufficient room
for a relay agent to add a Relay-Session-Id TAG.
</summary>
</member>
<member name="F:PacketDotNet.PPPoECode.ActiveDiscoveryTerminate">
<summary>
Indicate that the PPPoe session specified by the SessionId field of
the PPPoe packet has been terminated
</summary>
</member>
<member name="T:PacketDotNet.PPPPacket">
<summary>
PPP packet
See http://en.wikipedia.org/wiki/Point-to-Point_Protocol
</summary>
</member>
<member name="M:PacketDotNet.PPPPacket.#ctor(PacketDotNet.PPPoECode,System.UInt16)">
<summary>
Construct a new PPPPacket from source and destination mac addresses
</summary>
</member>
<member name="M:PacketDotNet.PPPPacket.#ctor(PacketDotNet.Utils.ByteArraySegment)">
<summary>
Constructor
</summary>
<param name="bas">
A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
</member>
<member name="P:PacketDotNet.PPPPacket.Protocol">
<summary>
See http://www.iana.org/assignments/ppp-numbers
</summary>
</member>
<member name="P:PacketDotNet.PPPPacket.Color">
<summary> Fetch ascii escape sequence of the color associated with this packet type.</summary>
</member>
<member name="M:PacketDotNet.PPPPacket.ToString(PacketDotNet.StringOutputType)">
<summary cref="Packet.ToString(StringOutputType)" />
</member>
<member name="M:PacketDotNet.PPPPacket.GetEncapsulated(PacketDotNet.Packet)">
<summary>
Returns the encapsulated PPPPacket of the Packet p or null if
there is no encapsulated packet
</summary>
<param name="p">
A <see cref="T:PacketDotNet.Packet" /></param>
<returns>
A <see cref="T:PacketDotNet.PPPPacket" /></returns>
</member>
<member name="M:PacketDotNet.PPPPacket.RandomPacket">
<summary>
Generate a random PPPoEPacket
</summary>
<returns>
A <see cref="T:PacketDotNet.PPPoEPacket" /></returns>
</member>
<member name="T:PacketDotNet.PPPFields">
<summary>
The fields in a PPP packet
See http://en.wikipedia.org/wiki/Point-to-Point_Protocol
</summary>
</member>
<member name="F:PacketDotNet.PPPFields.ProtocolLength">
<summary>
Length of the Protocol field in bytes, the field is of type
PPPProtocol
</summary>
</member>
<member name="F:PacketDotNet.PPPFields.ProtocolPosition">
<summary>
Offset from the start of the PPP packet where the Protocol field is located
</summary>
</member>
<member name="F:PacketDotNet.PPPFields.HeaderLength">
<summary>
The length of the header
</summary>
</member>
<member name="T:PacketDotNet.PPPProtocol">
<summary>
Indicates the protocol encapsulated by the PPP packet
See http://www.iana.org/assignments/ppp-numbers
</summary>
</member>
<member name="F:PacketDotNet.PPPProtocol.Padding">
<summary> Padding </summary>
</member>
<member name="F:PacketDotNet.PPPProtocol.IPv4">
<summary> IPv4 </summary>
</member>
<member name="F:PacketDotNet.PPPProtocol.IPv6">
<summary> IPv6 </summary>
</member>
<member name="T:PacketDotNet.ICMPv4TypeCodes">
<summary>
Code constants for ICMP message types.
From http://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#List_of_permitted_control_messages_.28incomplete_list.29
Note that these values represent the combined
type and code fields, where the type field is the upper byte
</summary>
</member>
<member name="T:PacketDotNet.ICMPv4Fields">
<summary>
ICMP protocol field encoding information.
See http://en.wikipedia.org/wiki/ICMPv6
</summary>
</member>
<member name="F:PacketDotNet.ICMPv4Fields.TypeCodeLength">
<summary> Length of the ICMP message type code in bytes.</summary>
</member>
<member name="F:PacketDotNet.ICMPv4Fields.ChecksumLength">
<summary> Length of the ICMP header checksum in bytes.</summary>
</member>
<member name="F:PacketDotNet.ICMPv4Fields.IDLength">
<summary> Length of the ICMP ID field in bytes.</summary>
</member>
<member name="F:PacketDotNet.ICMPv4Fields.SequenceLength">
<summary> Length of the ICMP Sequence field in bytes </summary>
</member>
<member name="F:PacketDotNet.ICMPv4Fields.TypeCodePosition">
<summary> Position of the ICMP message type/code.</summary>
</member>
<member name="F:PacketDotNet.ICMPv4Fields.ChecksumPosition">
<summary> Position of the ICMP header checksum.</summary>
</member>
<member name="F:PacketDotNet.ICMPv4Fields.IDPosition">
<summary> Position of the ICMP ID field </summary>
</member>
<member name="F:PacketDotNet.ICMPv4Fields.SequencePosition">
<summary> Position of the Sequence field </summary>
</member>
<member name="F:PacketDotNet.ICMPv4Fields.HeaderLength">
<summary> Length in bytes of an ICMP header.</summary>
</member>
<member name="T:PacketDotNet.ICMPv4Packet">
<summary>
An ICMP packet
See http://en.wikipedia.org/wiki/Internet_Control_Message_Protocol
</summary>
</member>
<member name="M:PacketDotNet.ICMPv4Packet.#ctor(PacketDotNet.Utils.ByteArraySegment)">
<summary>
Constructor
</summary>
<param name="bas">
A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
</member>
<member name="M:PacketDotNet.ICMPv4Packet.#ctor(PacketDotNet.Utils.ByteArraySegment,PacketDotNet.Packet)">
<summary>
Construct with parent packet
</summary>
<param name="bas">
A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
<param name="ParentPacket">
A <see cref="T:PacketDotNet.Packet" /></param>
</member>
<member name="P:PacketDotNet.ICMPv4Packet.TypeCode">
<value>
The Type/Code enum value
</value>
</member>
<member name="P:PacketDotNet.ICMPv4Packet.Checksum">
<value>
Checksum value
</value>
</member>
<member name="P:PacketDotNet.ICMPv4Packet.ID">
<summary>
ID field
</summary>
</member>
<member name="P:PacketDotNet.ICMPv4Packet.Sequence">
<summary>
Sequence field
</summary>
</member>
<member name="P:PacketDotNet.ICMPv4Packet.Data">
<summary>
Contents of the ICMP packet
</summary>
</member>
<member name="P:PacketDotNet.ICMPv4Packet.Color">
<summary> Fetch ascii escape sequence of the color associated with this packet type.</summary>
</member>
<member name="M:PacketDotNet.ICMPv4Packet.ToString(PacketDotNet.StringOutputType)">
<summary cref="Packet.ToString(StringOutputType)" />
</member>
<member name="M:PacketDotNet.ICMPv4Packet.GetEncapsulated(PacketDotNet.Packet)">
<summary>
Returns the ICMPv4Packet inside of Packet p or null if
there is no encapsulated ICMPv4Packet
</summary>
<param name="p">
A <see cref="T:PacketDotNet.Packet" /></param>
<returns>
A <see cref="T:PacketDotNet.ICMPv4Packet" /></returns>
</member>
<member name="T:PacketDotNet.Utils.ByteArraySegment">
<summary>
Container class that refers to a segment of bytes in a byte[]
Used to ensure high performance by allowing memory copies to
be avoided
</summary>
</member>
<member name="M:PacketDotNet.Utils.ByteArraySegment.#ctor(System.Byte[])">
<summary>
Constructor
</summary>
<param name="Bytes">
A <see cref="T:System.Byte[]" /></param>
</member>
<member name="M:PacketDotNet.Utils.ByteArraySegment.#ctor(System.Byte[],System.Int32,System.Int32)">
<summary>
Constructor from a byte array, offset into the byte array and
a length beyond that offset of the bytes this class is referencing
</summary>
<param name="Bytes">
A <see cref="T:System.Byte" /></param>
<param name="Offset">
A <see cref="T:System.Int32" /></param>
<param name="Length">
A <see cref="T:System.Int32" /></param>
</member>
<member name="M:PacketDotNet.Utils.ByteArraySegment.#ctor(System.Byte[],System.Int32,System.Int32,System.Int32)">
<summary>
Constructor
</summary>
<param name="Bytes">
A <see cref="T:System.Byte[]" /></param>
<param name="Offset">
A <see cref="T:System.Int32" /></param>
<param name="Length">
A <see cref="T:System.Int32" /></param>
<param name="BytesLength">
A <see cref="T:System.Int32" /></param>
</member>
<member name="M:PacketDotNet.Utils.ByteArraySegment.#ctor(PacketDotNet.Utils.ByteArraySegment)">
<summary>
Copy constructor
</summary>
<param name="original">
A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
</member>
<member name="P:PacketDotNet.Utils.ByteArraySegment.Bytes">
<value>
The byte[] array
</value>
</member>
<member name="P:PacketDotNet.Utils.ByteArraySegment.BytesLength">
<value>
The maximum number of bytes we should treat Bytes as having, allows
for controling the number of bytes produced by EncapsulatedBytes()
</value>
</member>
<member name="P:PacketDotNet.Utils.ByteArraySegment.Length">
<value>
Number of bytes beyond the offset into Bytes
</value>
</member>
<member name="P:PacketDotNet.Utils.ByteArraySegment.Offset">
<value>
Offset into Bytes
</value>
</member>
<member name="P:PacketDotNet.Utils.ByteArraySegment.NeedsCopyForActualBytes">
<summary>
Return true if we need to perform a copy to get
the bytes represented by this class
</summary>
<returns>
A <see cref="T:System.Boolean" /></returns>
</member>
<member name="M:PacketDotNet.Utils.ByteArraySegment.ActualBytes">
<summary>
Returns a contiguous byte[] from this container, if necessary, by copying
the bytes from the current offset into a newly allocated byte[].
NeedsCopyForActualBytes can be used to determine if the copy is necessary
</summary>
<returns>
A <see cref="T:System.Byte" /></returns>
</member>
<member name="M:PacketDotNet.Utils.ByteArraySegment.EncapsulatedBytes">
<summary>
Helper method that returns the segment immediately following
this instance, useful for processing where the parent
wants to pass the next segment to a sub class for processing
</summary>
<returns>
A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></returns>
</member>
<member name="M:PacketDotNet.Utils.ByteArraySegment.EncapsulatedBytes(System.Int32)">
<summary>
Create the segment after the current one
</summary>
<param name="NewSegmentLength">
A <see cref="T:System.Int32" /> that can be used to limit the segment length
of the ByteArraySegment that is to be returned. Often used to exclude trailing bytes.
</param>
<returns>
A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></returns>
</member>
<member name="M:PacketDotNet.Utils.ByteArraySegment.ToString">
<summary>
Format the class information as a string
</summary>
<returns>
A <see cref="T:System.String" /></returns>
</member>
<member name="T:PacketDotNet.PacketOrByteArraySegment">
<summary>
Encapsulates and ensures that we have either a Packet OR
a ByteArraySegment but not both
</summary>
</member>
<member name="P:PacketDotNet.PacketOrByteArraySegment.Type">
<value>
Whether or not this container contains a packet, a byte[] or neither
</value>
</member>
<member name="M:PacketDotNet.PacketOrByteArraySegment.AppendToMemoryStream(System.IO.MemoryStream)">
<summary>
Appends to the MemoryStream either the byte[] represented by TheByteArray, or
if ThePacket is non-null, the Packet.Bytes will be appended to the memory stream
which will append ThePacket's header and any encapsulated packets it contains
</summary>
<param name="ms">
A <see cref="T:System.IO.MemoryStream" /></param>
</member>
<member name="T:PacketDotNet.LLDPPacket">
<summary>
A LLDP packet.
As specified in IEEE Std 802.1AB
</summary>
<remarks>
See http://en.wikipedia.org/wiki/Link_Layer_Discovery_Protocol for general info
See IETF 802.1AB for the full specification
</remarks>
</member>
<member name="M:PacketDotNet.LLDPPacket.#ctor">
<summary>
Create an empty LLDPPacket
</summary>
</member>
<member name="M:PacketDotNet.LLDPPacket.#ctor(PacketDotNet.Utils.ByteArraySegment)">
<summary>
Constructor
</summary>
<param name="bas">
A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
</member>
<member name="F:PacketDotNet.LLDPPacket.TlvCollection">
<summary>
Contains the TLV's in the LLDPDU
</summary>
</member>
<member name="P:PacketDotNet.LLDPPacket.Item(System.Int32)">
<summary>
Allows access of the TlvCollection by index
</summary>
<param name="index">The index of the item being set/retrieved in the collection</param>
<returns>The requested TLV</returns>
</member>
<member name="P:PacketDotNet.LLDPPacket.Length">
<value>
The current length of the LLDPDU
</value>
</member>
<member name="P:PacketDotNet.LLDPPacket.BytesHighPerformance">
<summary>
LLDPPacket specific implementation of BytesHighPerformance
Necessary because each TLV in the collection may have a
byte[] that is not shared by other TLVs
NOTE: There is potential for the same performance improvement that
the Packet class uses where we check to see if each TLVs uses the
same byte[] and that there are no gaps.
</summary>
</member>
<member name="M:PacketDotNet.LLDPPacket.GetEnumerator">
<summary>
Enables foreach functionality for this class
</summary>
<returns>The next item in the list</returns>
</member>
<member name="M:PacketDotNet.LLDPPacket.ParseByteArrayIntoTlvs(System.Byte[],System.Int32)">
<summary>
Parse byte[] into TLVs
</summary>
</member>
<member name="M:PacketDotNet.LLDPPacket.TLVFactory(System.Byte[],System.Int32,PacketDotNet.LLDP.TLVTypes)">
<summary>
</summary>
<param name="Bytes">
A <see cref="T:System.Byte[]" /></param>
<param name="offset">
A <see cref="T:System.Int32" /></param>
<param name="type">
A <see cref="T:PacketDotNet.LLDP.TLVTypes" /></param>
<returns>
A <see cref="T:PacketDotNet.LLDP.TLV" /></returns>
</member>
<member name="M:PacketDotNet.LLDPPacket.GetEncapsulated(PacketDotNet.Packet)">
<summary>
Returns the LLDP inside of the Packet p or null if
there is no encapsulated packet
</summary>
<param name="p">
A <see cref="T:PacketDotNet.Packet" /></param>
<returns>
A <see cref="T:PacketDotNet.IpPacket" /></returns>
</member>
<member name="M:PacketDotNet.LLDPPacket.RandomPacket">
<summary>
Create a randomized LLDP packet with some basic TLVs
</summary>
<returns>
A <see cref="T:PacketDotNet.Packet" /></returns>
</member>
<member name="M:PacketDotNet.LLDPPacket.ToString(PacketDotNet.StringOutputType)">
<summary cref="Packet.ToString(StringOutputType)" />
</member>
<member name="T:PacketDotNet.LLDP.TLVTypes">
<summary>
The TLV Types
</summary>
<remarks>
See IETF RFC 802.1AB for more info
</remarks>
</member>
<member name="F:PacketDotNet.LLDP.TLVTypes.EndOfLLDPU">
<summary>Signifies the end of a LLDPU</summary>
<description>
The End Of LLDPDU TLV is a 2-octet, all-zero
TLV that is used to mark the end of the TLV
sequence in LLDPDUs
</description>
<remarks>Source: IETF RFC 802.1AB</remarks>
</member>
<member name="F:PacketDotNet.LLDP.TLVTypes.ChassisID">
<summary>A Chassis Identifier</summary>
<description>
A mandatory TLV that identifies the chassis
containing the IEEE 802 LAN station
associated with the transmitting LLDP agent
</description>
<remarks>Source: IETF RFC 802.1AB</remarks>
</member>
<member name="F:PacketDotNet.LLDP.TLVTypes.PortID">
<summary>A Port Identifier</summary>
<description>
A mandatory TLV that identifies the
port component of the MSAP identifier associated
with the transmitting LLDP agent.
</description>
<remarks>Source: IETF RFC 802.1AB</remarks>
</member>
<member name="F:PacketDotNet.LLDP.TLVTypes.TimeToLive">
<summary>Specifies the Time to Live</summary>
<description>
Indicates the number of seconds that the
recipient LLDP agent is to regard the information
associated with this MSAP identifier to be valid
A value of 0 signals that this source is no longer
available and all information associated with it
should be deleted.
</description>
<remarks>Source: IETF RFC 802.1AB</remarks>
</member>
<member name="F:PacketDotNet.LLDP.TLVTypes.PortDescription">
<summary>A Description of the Port</summary>
<description>
The port description field shall contain an
alpha-numeric string that indicates the port’s
description.
</description>
<remarks>Source: IETF RFC 802.1AB</remarks>
</member>
<member name="F:PacketDotNet.LLDP.TLVTypes.SystemName">
<summary>The System's Assigned Name</summary>
<description>
The System Name TLV allows network management
to advertise the system’s assigned name.
</description>
<remarks>Source: IETF RFC 802.1AB</remarks>
</member>
<member name="F:PacketDotNet.LLDP.TLVTypes.SystemDescription">
<summary>A Description of the System</summary>
<description>
The System Description TLV allows network
management to advertise the system’s description
</description>
<remarks>Source: IETF RFC 802.1AB</remarks>
</member>
<member name="F:PacketDotNet.LLDP.TLVTypes.SystemCapabilities">
<summary>A bitmap containing the System's capabilities</summary>
<description>
The System Capabilities TLV is an optional TLV
that identifies the primary function(s) of the
system and whether or not these primary functions
are enabled.
</description>
<remarks>Source: IETF RFC 802.1AB</remarks>
</member>
<member name="F:PacketDotNet.LLDP.TLVTypes.ManagementAddress">
<summary>The Management Address</summary>
<description>
The Management Address TLV identifies an address
associated with the local LLDP agent that may be
used to reach higher layer entities to assist
discovery by network management.
</description>
<remarks>Source: IETF RFC 802.1AB</remarks>
</member>
<member name="F:PacketDotNet.LLDP.TLVTypes.OrganizationSpecific">
<summary>A vendor-specifid TLV</summary>
<description>
This TLV category is provided to allow different
organizations, such as IEEE 802.1, IEEE 802.3, IETF,
as well as individual software and equipment vendors,
to define TLVs that advertise information to remote
entities attached to the same media.
</description>
<remarks>Source: IETF RFC 802.1AB</remarks>
</member>
<member name="T:PacketDotNet.LLDP.ChassisSubTypes">
<summary>
The Chassis ID TLV subtypes
</summary>
</member>
<member name="F:PacketDotNet.LLDP.ChassisSubTypes.ChassisComponent">
<summary>A Chassis Component identifier</summary>
<remarks>See IETF RFC 2737</remarks>
</member>
<member name="F:PacketDotNet.LLDP.ChassisSubTypes.InterfaceAlias">
<summary>An Interface Alias identifier</summary>
<remarks>See IETF RFC 2863</remarks>
</member>
<member name="F:PacketDotNet.LLDP.ChassisSubTypes.PortComponent">
<summary>A Port Component identifier</summary>
<remarks>See IETF RFC 2737</remarks>
</member>
<member name="F:PacketDotNet.LLDP.ChassisSubTypes.MACAddress">
<summary>A MAC (Media Access Control) Address identifier</summary>
<remarks>See IEEE Std 802</remarks>
</member>
<member name="F:PacketDotNet.LLDP.ChassisSubTypes.NetworkAddress">
<summary>A Network Address (IP Address) Identifier</summary>
<remarks>See IEEE Std 802</remarks>
</member>
<member name="F:PacketDotNet.LLDP.ChassisSubTypes.InterfaceName">
<summary>An Interface Name identifier</summary>
<remarks>See IEEE Std 802</remarks>
</member>
<member name="F:PacketDotNet.LLDP.ChassisSubTypes.LocallyAssigned">
<summary>A Locally Assigned identifier</summary>
</member>
<member name="T:PacketDotNet.LLDP.PortSubTypes">
<summary>
The Port ID TLV subtypes
</summary>
</member>
<member name="F:PacketDotNet.LLDP.PortSubTypes.InterfaceAlias">
<summary>An Interface Alias identifier</summary>
<remarks>See IETF RFC 2863</remarks>
</member>
<member name="F:PacketDotNet.LLDP.PortSubTypes.PortComponent">
<summary>A Port Component identifier</summary>
<remarks>See IETF RFC 2737</remarks>
</member>
<member name="F:PacketDotNet.LLDP.PortSubTypes.MACAddress">
<summary>A MAC (Media Access Control) Address identifier</summary>
<remarks>See IEEE Std 802</remarks>
</member>
<member name="F:PacketDotNet.LLDP.PortSubTypes.NetworkAddress">
<summary>A Network Address (IP Address) Identifier</summary>
<remarks>See IEEE Std 802</remarks>
</member>
<member name="F:PacketDotNet.LLDP.PortSubTypes.InterfaceName">
<summary>An Interface Name identifier</summary>
<remarks>See IEEE Std 802</remarks>
</member>
<member name="F:PacketDotNet.LLDP.PortSubTypes.AgentCircuitID">
<summary>An Agent Circiut ID identifier</summary>
<remarks>See IETF RFC 3046</remarks>
</member>
<member name="F:PacketDotNet.LLDP.PortSubTypes.LocallyAssigned">
<summary>A Locally Assigned identifier</summary>
<remarks>See IETF RFC 3046</remarks>
</member>
<member name="T:PacketDotNet.LLDP.CapabilityOptions">
<summary>
The System Capabilities options
</summary>
</member>
<member name="F:PacketDotNet.LLDP.CapabilityOptions.Other">
<summary>
An Other Type of System
</summary>
</member>
<member name="F:PacketDotNet.LLDP.CapabilityOptions.Repeater">
<summary>A Repeater</summary>
<remarks>See IETF RFC 2108</remarks>
</member>
<member name="F:PacketDotNet.LLDP.CapabilityOptions.Bridge">
<summary>A Bridge</summary>
<remarks>IETF RFC 2674</remarks>
</member>
<member name="F:PacketDotNet.LLDP.CapabilityOptions.WLanAP">
<summary>A WLAN Access Point</summary>
<remarks>IEEE 802.11 MIB</remarks>
</member>
<member name="F:PacketDotNet.LLDP.CapabilityOptions.Router">
<summary>A Router</summary>
<remarks>IETF RFC 1812</remarks>
</member>
<member name="F:PacketDotNet.LLDP.CapabilityOptions.Telephone">
<summary>A Telephone</summary>
<remarks>IETF RFC 2011 </remarks>
</member>
<member name="F:PacketDotNet.LLDP.CapabilityOptions.DocsisCableDevice">
<summary>A DOCSIS Cable Device</summary>
<remarks>
See IETF RFC 2669
See IETF RFC 2670
</remarks>
</member>
<member name="F:PacketDotNet.LLDP.CapabilityOptions.StationOnly">
<summary>A Station with no other capabilities</summary>
<remarks>IETF RFC 2011</remarks>
</member>
<member name="T:PacketDotNet.LLDP.TLV">
<summary>
A Type-Length-Value object
</summary>
</member>
<member name="M:PacketDotNet.LLDP.TLV.#ctor">
<summary>
Create a tlv
</summary>
</member>
<member name="M:PacketDotNet.LLDP.TLV.#ctor(System.Byte[],System.Int32)">
<summary>
Creates a TLV
</summary>
<param name="bytes">
Bytes that comprise the TLV
</param>
<param name="offset">
The TLVs offset from the start of byte[] bytes
</param>
</member>
<member name="F:PacketDotNet.LLDP.TLV._tlvData">
<summary>
Points to the TLV data
</summary>
</member>
<member name="F:PacketDotNet.LLDP.TLV.TypeLength">
<summary>
Interface to this TLVs type and length
</summary>
</member>
<member name="P:PacketDotNet.LLDP.TLV.Length">
<summary>
Length of value portion of the TLV
NOTE: Does not include the length of the Type and Length fields
</summary>
</member>
<member name="P:PacketDotNet.LLDP.TLV.TotalLength">
<summary>
Total length of the TLV, including the length of the Type and Length fields
</summary>
</member>
<member name="P:PacketDotNet.LLDP.TLV.Type">
<summary>
Tlv type
</summary>
</member>
<member name="P:PacketDotNet.LLDP.TLV.ValueOffset">
<summary>
Offset to the value bytes of the TLV
</summary>
</member>
<member name="P:PacketDotNet.LLDP.TLV.Bytes">
<summary>
Return a byte[] that contains the tlv
</summary>
</member>
<member name="P:PacketDotNet.LLDP.TLV.tlvData">
<summary>
Points to the TLV data
</summary>
</member>
<member name="T:PacketDotNet.LLDP.NetworkAddress">
<summary>
A Network Address
</summary>
</member>
<member name="M:PacketDotNet.LLDP.NetworkAddress.#ctor(System.Net.IPAddress)">
<summary>
Creates a Network Address entity
</summary>
<param name="address">
The Network Address
</param>
</member>
<member name="M:PacketDotNet.LLDP.NetworkAddress.#ctor(System.Byte[],System.Int32,System.Int32)">
<summary>
Create a network address from byte data
</summary>
<param name="bytes">
A <see cref="T:System.Byte[]" /></param>
<param name="offset">
A <see cref="T:System.Int32" /></param>
<param name="length">
A <see cref="T:System.Int32" /></param>
</member>
<member name="F:PacketDotNet.LLDP.NetworkAddress.AddressFamilyLength">
<summary>
Length of AddressFamily field in bytes
</summary>
</member>
<member name="P:PacketDotNet.LLDP.NetworkAddress.Length">
<summary>
Number of bytes in the NetworkAddress
</summary>
</member>
<member name="P:PacketDotNet.LLDP.NetworkAddress.AddressFamily">
<summary>The format of the Network Address</summary>
</member>
<member name="P:PacketDotNet.LLDP.NetworkAddress.Address">
<summary>The Network Address</summary>
</member>
<member name="M:PacketDotNet.LLDP.NetworkAddress.Equals(System.Object)">
<summary>
Equals override
</summary>
<param name="obj">
A <see cref="T:System.Object" /></param>
<returns>
A <see cref="T:System.Boolean" /></returns>
</member>
<member name="M:PacketDotNet.LLDP.NetworkAddress.GetHashCode">
<summary>
GetHashCode() override
</summary>
<returns>
A <see cref="T:System.Int32" /></returns>
</member>
<member name="M:PacketDotNet.LLDP.NetworkAddress.ToString">
<summary>
ToString() override
</summary>
<returns>
A <see cref="T:System.String" /></returns>
</member>
<member name="T:PacketDotNet.LLDP.InterfaceNumbering">
<summary>
Interface Numbering Types
</summary>
<remarks>Source IETF RFC 802.1AB</remarks>
</member>
<member name="F:PacketDotNet.LLDP.InterfaceNumbering.Unknown">
<summary>Unknown</summary>
</member>
<member name="F:PacketDotNet.LLDP.InterfaceNumbering.ifIndex">
<summary>Interface Index</summary>
</member>
<member name="F:PacketDotNet.LLDP.InterfaceNumbering.SystemPortNumber">
<summary>System Port Number</summary>
</member>
<member name="T:PacketDotNet.LLDP.EndOfLLDPDU">
<summary>
An End Of LLDPDU TLV
</summary>
</member>
<member name="M:PacketDotNet.LLDP.EndOfLLDPDU.#ctor(System.Byte[],System.Int32)">
<summary>
Parses bytes into an End Of LLDPDU TLV
</summary>
<param name="bytes">
TLV bytes
</param>
<param name="offset">
The End Of LLDPDU TLV's offset from the
origin of the LLDP
</param>
</member>
<member name="M:PacketDotNet.LLDP.EndOfLLDPDU.#ctor">
<summary>
Creates an End Of LLDPDU TLV
</summary>
</member>
<member name="M:PacketDotNet.LLDP.EndOfLLDPDU.ToString">
<summary>
Convert this TTL TLV to a string.
</summary>
<returns>
A human readable string
</returns>
</member>
<member name="T:PacketDotNet.LLDP.ChassisID">
<summary>
A Chassis ID TLV
</summary>
</member>
<member name="M:PacketDotNet.LLDP.ChassisID.#ctor(System.Byte[],System.Int32)">
<summary>
Creates a Chassis ID TLV by parsing a byte[]
</summary>
<param name="bytes">
</param>
<param name="offset">
The Chassis ID TLV's offset from the
origin of the LLDP
</param>
</member>
<member name="M:PacketDotNet.LLDP.ChassisID.#ctor(PacketDotNet.LLDP.ChassisSubTypes,System.Object)">
<summary>
Creates a Chassis ID TLV and sets it value
</summary>
<param name="subType">
The ChassisID subtype
</param>
<param name="subTypeValue">
The subtype's value
</param>
</member>
<member name="M:PacketDotNet.LLDP.ChassisID.#ctor(System.Net.NetworkInformation.PhysicalAddress)">
<summary>
Create a ChassisID given a mac address
</summary>
<param name="MACAddress">
A <see cref="T:System.Net.NetworkInformation.PhysicalAddress" /></param>
</member>
<member name="M:PacketDotNet.LLDP.ChassisID.#ctor(System.String)">
<summary>
Create a ChassisID given an interface name
http://tools.ietf.org/search/rfc2863 page 38
</summary>
<param name="InterfaceName">
A <see cref="T:System.String" /></param>
</member>
<member name="F:PacketDotNet.LLDP.ChassisID.SubTypeLength">
<summary>
Length of the sub type field in bytes
</summary>
</member>
<member name="P:PacketDotNet.LLDP.ChassisID.SubType">
<value>
The type of the TLV subtype
</value>
</member>
<member name="P:PacketDotNet.LLDP.ChassisID.SubTypeValue">
<value>
The TLV subtype value
</value>
</member>
<member name="P:PacketDotNet.LLDP.ChassisID.ChassisComponent">
<summary>
If SubType is ChassisComponent
</summary>
</member>
<member name="P:PacketDotNet.LLDP.ChassisID.InterfaceName">
<summary>
If SubType is InterfaceName the interface name
</summary>
</member>
<member name="P:PacketDotNet.LLDP.ChassisID.MACAddress">
<summary>
If SubType is MACAddress the mac address
</summary>
</member>
<member name="P:PacketDotNet.LLDP.ChassisID.NetworkAddress">
<summary>
If SubType is NetworkAddress the network address
</summary>
</member>
<member name="P:PacketDotNet.LLDP.ChassisID.PortComponent">
<summary>
If SubType is PortComponent
</summary>
</member>
<member name="P:PacketDotNet.LLDP.ChassisID.InterfaceAlias">
<summary>
If SubType is InterfaceAlias
</summary>
</member>
<member name="M:PacketDotNet.LLDP.ChassisID.EmptyTLVDataInit">
<summary>
Helper method to reduce duplication in type specific constructors
</summary>
</member>
<member name="M:PacketDotNet.LLDP.ChassisID.ToString">
<summary>
Convert this Chassis ID TLV to a string.
</summary>
<returns>
A human readable string
</returns>
</member>
<member name="T:PacketDotNet.LLDP.PortID">
<summary>
A Port ID TLV
</summary>
</member>
<member name="M:PacketDotNet.LLDP.PortID.#ctor(System.Byte[],System.Int32)">
<summary>
Creates a Port ID TLV
</summary>
<param name="bytes">
</param>
<param name="offset">
The Port ID TLV's offset from the
origin of the LLDP
</param>
</member>
<member name="M:PacketDotNet.LLDP.PortID.#ctor(PacketDotNet.LLDP.PortSubTypes,System.Object)">
<summary>
Creates a Port ID TLV and sets it value
</summary>
<param name="subType">
The Port ID SubType
</param>
<param name="subTypeValue">
The subtype's value
</param>
</member>
<member name="M:PacketDotNet.LLDP.PortID.#ctor(PacketDotNet.LLDP.NetworkAddress)">
<summary>
Construct a PortID from a NetworkAddress
</summary>
<param name="networkAddress">
A <see cref="T:PacketDotNet.LLDP.NetworkAddress" /></param>
</member>
<member name="P:PacketDotNet.LLDP.PortID.SubType">
<value>
The type of the TLV subtype
</value>
</member>
<member name="P:PacketDotNet.LLDP.PortID.SubTypeValue">
<value>
The TLV subtype value
</value>
</member>
<member name="P:PacketDotNet.LLDP.PortID.DataOffset">
<summary>
Offset to the value field
</summary>
</member>
<member name="P:PacketDotNet.LLDP.PortID.DataLength">
<summary>
Size of the value field
</summary>
</member>
<member name="M:PacketDotNet.LLDP.PortID.EmptyTLVDataInit">
<summary>
Helper method to reduce duplication in type specific constructors
</summary>
</member>
<member name="M:PacketDotNet.LLDP.PortID.ToString">
<summary>
Convert this Port ID TLV to a string.
</summary>
<returns>
A human readable string
</returns>
</member>
<member name="T:PacketDotNet.LLDP.TimeToLive">
<summary>
A Time to Live TLV
</summary>
</member>
<member name="M:PacketDotNet.LLDP.TimeToLive.#ctor(System.Byte[],System.Int32)">
<summary>
Creates a TTL TLV
</summary>
<param name="bytes">
</param>
<param name="offset">
The TTL TLV's offset from the
origin of the LLDP
</param>
</member>
<member name="M:PacketDotNet.LLDP.TimeToLive.#ctor(System.UInt16)">
<summary>
Creates a TTL TLV and sets it value
</summary>
<param name="seconds">
The length in seconds until the LLDP
is refreshed
</param>
</member>
<member name="F:PacketDotNet.LLDP.TimeToLive.ValueLength">
<summary>
Number of bytes in the value portion of this tlv
</summary>
</member>
<member name="P:PacketDotNet.LLDP.TimeToLive.Seconds">
<value>
The number of seconds until the LLDP needs
to be refreshed
A value of 0 means that the LLDP source is
closed and should no longer be refreshed
</value>
</member>
<member name="M:PacketDotNet.LLDP.TimeToLive.ToString">
<summary>
Convert this TTL TLV to a string.
</summary>
<returns>
A human readable string
</returns>
</member>
<member name="T:PacketDotNet.LLDP.PortDescription">
<summary>
A Port Description TLV
</summary>
</member>
<member name="M:PacketDotNet.LLDP.PortDescription.#ctor(System.Byte[],System.Int32)">
<summary>
Creates a Port Description TLV
</summary>
<param name="bytes">
</param>
<param name="offset">
The Port Description TLV's offset from the
origin of the LLDP
</param>
</member>
<member name="M:PacketDotNet.LLDP.PortDescription.#ctor(System.String)">
<summary>
Creates a Port Description TLV and sets it value
</summary>
<param name="description">
A textual description of the port
</param>
</member>
<member name="P:PacketDotNet.LLDP.PortDescription.Description">
<value>
A textual Description of the port
</value>
</member>
<member name="T:PacketDotNet.LLDP.SystemName">
<summary>
A System Name TLV
</summary>
</member>
<member name="M:PacketDotNet.LLDP.SystemName.#ctor(System.Byte[],System.Int32)">
<summary>
Creates a System Name TLV
</summary>
<param name="bytes">
</param>
<param name="offset">
The System Name TLV's offset from the
origin of the LLDP
</param>
</member>
<member name="M:PacketDotNet.LLDP.SystemName.#ctor(System.String)">
<summary>
Creates a System Name TLV and sets it value
</summary>
<param name="name">
A textual Name of the system
</param>
</member>
<member name="P:PacketDotNet.LLDP.SystemName.Name">
<value>
A textual Name of the system
</value>
</member>
<member name="T:PacketDotNet.LLDP.SystemDescription">
<summary>
A System Description TLV
</summary>
</member>
<member name="M:PacketDotNet.LLDP.SystemDescription.#ctor(System.Byte[],System.Int32)">
<summary>
Creates a System Description TLV
</summary>
<param name="bytes">
</param>
<param name="offset">
The System Description TLV's offset from the
origin of the LLDP
</param>
</member>
<member name="M:PacketDotNet.LLDP.SystemDescription.#ctor(System.String)">
<summary>
Creates a System Description TLV and sets it value
</summary>
<param name="description">
A textual Description of the system
</param>
</member>
<member name="P:PacketDotNet.LLDP.SystemDescription.Description">
<value>
A textual Description of the system
</value>
</member>
<member name="T:PacketDotNet.LLDP.SystemCapabilities">
<summary>
A System Capabilities TLV
[TLVTypeLength - 2 bytes][System Capabilities - 2 bytes][Enabled Capabilities - 2 bytes]
</summary>
</member>
<member name="M:PacketDotNet.LLDP.SystemCapabilities.#ctor(System.Byte[],System.Int32)">
<summary>
Creates a System Capabilities TLV
</summary>
<param name="bytes">
</param>
<param name="offset">
The System Capabilities TLV's offset from the
origin of the LLDP
</param>
</member>
<member name="M:PacketDotNet.LLDP.SystemCapabilities.#ctor(System.UInt16,System.UInt16)">
<summary>
Creates a System Capabilities TLV and sets the value
</summary>
<param name="capabilities">
A bitmap containing the available System Capabilities
</param>
<param name="enabled">
A bitmap containing the enabled System Capabilities
</param>
</member>
<member name="P:PacketDotNet.LLDP.SystemCapabilities.Capabilities">
<value>
A bitmap containing the available System Capabilities
</value>
</member>
<member name="P:PacketDotNet.LLDP.SystemCapabilities.Enabled">
<value>
A bitmap containing the Enabled System Capabilities
</value>
</member>
<member name="M:PacketDotNet.LLDP.SystemCapabilities.IsCapable(PacketDotNet.LLDP.CapabilityOptions)">
<summary>
Checks whether the system is capable of a certain function
</summary>
<param name="capability">
The capability being checked
</param>
<returns>
Whether or not the system is capable of the function being tested
</returns>
</member>
<member name="M:PacketDotNet.LLDP.SystemCapabilities.IsEnabled(PacketDotNet.LLDP.CapabilityOptions)">
<summary>
Checks whether the specified function has been enabled on the system
</summary>
<param name="capability">
The capability being checked
</param>
<returns>
Whether or not the specified function is enabled
</returns>
</member>
<member name="M:PacketDotNet.LLDP.SystemCapabilities.ToString">
<summary>
Convert this System Capabilities TLV to a string.
</summary>
<returns>
A human readable string
</returns>
</member>
<member name="T:PacketDotNet.LLDP.ManagementAddress">
<summary>
A Time to Live TLV
[TLV Type Length : 2][Mgmt Addr length : 1][Mgmt Addr Subtype : 1][Mgmt Addr : 1-31]
[Interface Subtype : 1][Interface number : 4][OID length : 1][OID : 0-128]
</summary>
</member>
<member name="M:PacketDotNet.LLDP.ManagementAddress.#ctor(System.Byte[],System.Int32)">
<summary>
Creates a Management Address TLV
</summary>
<param name="bytes">
The LLDP Data unit being modified
</param>
<param name="offset">
The Management Address TLV's offset from the
origin of the LLDP
</param>
</member>
<member name="M:PacketDotNet.LLDP.ManagementAddress.#ctor(PacketDotNet.LLDP.NetworkAddress,PacketDotNet.LLDP.InterfaceNumbering,System.UInt32,System.String)">
<summary>
Creates a Management Address TLV and sets it value
</summary>
<param name="managementAddress">
The Management Address
</param>
<param name="interfaceSubType">
The Interface Numbering Sub Type
</param>
<param name="ifNumber">
The Interface Number
</param>
<param name="oid">
The Object Identifier
</param>
</member>
<member name="F:PacketDotNet.LLDP.ManagementAddress.MgmtAddressLengthLength">
<summary>
Number of bytes in the AddressLength field
</summary>
</member>
<member name="F:PacketDotNet.LLDP.ManagementAddress.InterfaceNumberSubTypeLength">
<summary>
Number of bytes in the interface number subtype field
</summary>
</member>
<member name="F:PacketDotNet.LLDP.ManagementAddress.InterfaceNumberLength">
<summary>
Number of bytes in the interface number field
</summary>
</member>
<member name="F:PacketDotNet.LLDP.ManagementAddress.ObjectIdentifierLengthLength">
<summary>
Number of bytes in the object identifier length field
</summary>
</member>
<member name="F:PacketDotNet.LLDP.ManagementAddress.maxObjectIdentifierLength">
<summary>
Maximum number of bytes in the object identifier field
</summary>
</member>
<member name="P:PacketDotNet.LLDP.ManagementAddress.AddressLength">
<value>
The Management Address Length
</value>
</member>
<member name="P:PacketDotNet.LLDP.ManagementAddress.AddressSubType">
<value>
The Management Address Subtype
Forward to the MgmtAddress instance
</value>
</member>
<member name="P:PacketDotNet.LLDP.ManagementAddress.MgmtAddress">
<value>
The Management Address
</value>
</member>
<member name="P:PacketDotNet.LLDP.ManagementAddress.InterfaceSubType">
<value>
Interface Number Sub Type
</value>
</member>
<member name="P:PacketDotNet.LLDP.ManagementAddress.InterfaceNumber">
<value>
Interface Number
</value>
</member>
<member name="P:PacketDotNet.LLDP.ManagementAddress.ObjIdLength">
<value>
Object ID Length
</value>
</member>
<member name="P:PacketDotNet.LLDP.ManagementAddress.ObjectIdentifier">
<value>
Object ID
</value>
</member>
<member name="M:PacketDotNet.LLDP.ManagementAddress.ToString">
<summary>
Convert this Management Address TLV to a string.
</summary>
<returns>
A human readable string
</returns>
</member>
<member name="T:PacketDotNet.LLDP.OrganizationSpecific">
<summary>
An Organization Specific TLV
[TLV Type Length : 2][Organizationally Unique Identifier OUI : 3]
[Organizationally Defined Subtype : 1][Organizationally Defined Information String : 0 - 507]
</summary>
</member>
<member name="M:PacketDotNet.LLDP.OrganizationSpecific.#ctor(System.Byte[],System.Int32)">
<summary>
Creates an Organization Specific TLV
</summary>
<param name="bytes">
The LLDP Data unit being modified
</param>
<param name="offset">
The Organization Specific TLV's offset from the
origin of the LLDP
</param>
</member>
<member name="M:PacketDotNet.LLDP.OrganizationSpecific.#ctor(System.Byte[],System.Int32,System.Byte[])">
<summary>
Creates an Organization Specific TLV and sets it value
</summary>
<param name="oui">
An Organizationally Unique Identifier
</param>
<param name="subType">
An Organizationally Defined SubType
</param>
<param name="infoString">
An Organizationally Defined Information String
</param>
</member>
<member name="P:PacketDotNet.LLDP.OrganizationSpecific.OrganizationUniqueID">
<summary>
An Organizationally Unique Identifier
</summary>
</member>
<member name="P:PacketDotNet.LLDP.OrganizationSpecific.OrganizationDefinedSubType">
<summary>
An Organizationally Defined SubType
</summary>
</member>
<member name="P:PacketDotNet.LLDP.OrganizationSpecific.OrganizationDefinedInfoString">
<summary>
An Organizationally Defined Information String
</summary>
</member>
<member name="M:PacketDotNet.LLDP.OrganizationSpecific.ToString">
<summary>
Convert this Organization Specific TLV to a string.
</summary>
<returns>
A human readable string
</returns>
</member>
<member name="T:PacketDotNet.LLDP.TLVTypeLength">
<summary>
Tlv type and length are 2 bytes
See http://en.wikipedia.org/wiki/Link_Layer_Discovery_Protocol#Frame_structure
</summary>
</member>
<member name="M:PacketDotNet.LLDP.TLVTypeLength.#ctor(PacketDotNet.Utils.ByteArraySegment)">
<summary>
Construct a TLVTypeLength for a TLV
</summary>
<param name="byteArraySegment">
A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
</member>
<member name="F:PacketDotNet.LLDP.TLVTypeLength.TypeLengthLength">
<summary>
Length in bytes of the tlv type and length fields
</summary>
</member>
<member name="P:PacketDotNet.LLDP.TLVTypeLength.Type">
<value>
The TLV Value's Type
</value>
</member>
<member name="P:PacketDotNet.LLDP.TLVTypeLength.Length">
<value>
The TLV Value's Length
NOTE: Value is the length of the TLV Value only, does not include the length
of the type and length fields
</value>
</member>
<member name="P:PacketDotNet.LLDP.TLVTypeLength.TypeAndLength">
<value>
A unsigned short representing the concatenated Type and Length
</value>
</member>
<member name="T:PacketDotNet.LLDP.AddressFamily">
<summary>
The IANA (Internet Assigned Numbers Authority) Address Family
</summary>
<remarks>Source http://www.iana.org/assignments/address-family-numbers/</remarks>
</member>
<member name="F:PacketDotNet.LLDP.AddressFamily.IPv4">
<summary>IP version 4</summary>
</member>
<member name="F:PacketDotNet.LLDP.AddressFamily.IPv6">
<summary>IP version 6</summary>
</member>
<member name="F:PacketDotNet.LLDP.AddressFamily.NSAP">
<summary>NSAP</summary>
</member>
<member name="F:PacketDotNet.LLDP.AddressFamily.HDLC">
<summary>HDLC</summary>
</member>
<member name="F:PacketDotNet.LLDP.AddressFamily.BBN1822">
<summary>BBN 1822</summary>
</member>
<member name="F:PacketDotNet.LLDP.AddressFamily.Eth802">
<summary>802 (includes all 802 media plus Ethernet "canonical format")</summary>
</member>
<member name="F:PacketDotNet.LLDP.AddressFamily.E163">
<summary>E.163</summary>
</member>
<member name="T:PacketDotNet.LLDP.StringTLV">
<summary>
Base class for several TLV types that all contain strings
</summary>
</member>
<member name="M:PacketDotNet.LLDP.StringTLV.#ctor(System.Byte[],System.Int32)">
<summary>
Creates a String TLV
</summary>
<param name="bytes">
</param>
<param name="offset">
The Port Description TLV's offset from the
origin of the LLDP
</param>
</member>
<member name="M:PacketDotNet.LLDP.StringTLV.#ctor(PacketDotNet.LLDP.TLVTypes,System.String)">
<summary>
Create from a type and string value
</summary>
<param name="tlvType">
A <see cref="T:PacketDotNet.LLDP.TLVTypes" /></param>
<param name="StringValue">
A <see cref="T:System.String" /></param>
</member>
<member name="P:PacketDotNet.LLDP.StringTLV.StringValue">
<value>
A textual Description of the port
</value>
</member>
<member name="M:PacketDotNet.LLDP.StringTLV.ToString">
<summary>
Convert this Port Description TLV to a string.
</summary>
<returns>
A human readable string
</returns>
</member>
<member name="T:PacketDotNet.TLVCollection">
<summary>
Custom collection for TLV types
Special behavior includes:
- Preventing an EndOfLLDPDU tlv from being added out of place
- Checking and throwing exceptions if one-per-LLDP packet TLVs are added multiple times
</summary>
</member>
<member name="M:PacketDotNet.TLVCollection.InsertItem(System.Int32,PacketDotNet.LLDP.TLV)">
<summary>
Override to:
- Prevent duplicate end tlvs from being added
- Ensure that an end tlv is present
- Replace any automatically added end tlvs with the user provided tlv
</summary>
<param name="index">
A <see cref="T:System.Int32" /></param>
<param name="item">
A <see cref="T:PacketDotNet.LLDP.TLV" /></param>
</member>
<member name="T:PacketDotNet.WakeOnLanPacket">
<summary>
Wake-On-Lan
See: http://en.wikipedia.org/wiki/Wake-on-LAN
See: http://wiki.wireshark.org/WakeOnLAN
</summary>
</member>
<member name="M:PacketDotNet.WakeOnLanPacket.#ctor(System.Net.NetworkInformation.PhysicalAddress)">
<summary>
Create a Wake-On-LAN packet from the destination MAC address
</summary>
<param name="destinationMAC">
A <see cref="T:System.Net.NetworkInformation.PhysicalAddress" /></param>
</member>
<member name="M:PacketDotNet.WakeOnLanPacket.#ctor(PacketDotNet.Utils.ByteArraySegment)">
<summary>
Constructor
</summary>
<param name="bas">
A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
</member>
<member name="P:PacketDotNet.WakeOnLanPacket.DestinationMAC">
<summary>
The Physical Address (MAC) of the host being woken up from sleep
</summary>
</member>
<member name="M:PacketDotNet.WakeOnLanPacket.GetEncapsulated(PacketDotNet.Packet)">
<summary>
Returns the embedded Wake-On-LAN packet
or null if there is none
</summary>
<returns>
A Wake-On-LAN packet
</returns>
</member>
<member name="M:PacketDotNet.WakeOnLanPacket.RandomPacket">
<summary>
Generate a random WakeOnLanPacket
</summary>
<returns>
A <see cref="T:PacketDotNet.WakeOnLanPacket" /></returns>
</member>
<member name="M:PacketDotNet.WakeOnLanPacket.IsValid">
<summary>
Checks the validity of the Wake-On-LAN payload
- by checking the synchronization sequence
- by checking to see if there are 16 iterations of the Destination MAC address
</summary>
<returns>
True if the Wake-On-LAN payload is valid
</returns>
</member>
<member name="M:PacketDotNet.WakeOnLanPacket.IsValid(PacketDotNet.Utils.ByteArraySegment)">
<summary>
See IsValid
</summary>
<param name="bas">
A <see cref="T:PacketDotNet.Utils.ByteArraySegment" /></param>
<returns>
A <see cref="T:System.Boolean" /></returns>
</member>
<member name="M:PacketDotNet.WakeOnLanPacket.Equals(System.Object)">
<summary>
Compare two instances
</summary>
<param name="obj">
A <see cref="T:System.Object" /></param>
<returns>
A <see cref="T:System.Boolean" /></returns>
</member>
<member name="M:PacketDotNet.WakeOnLanPacket.GetHashCode">
<summary>
GetHashCode override
</summary>
<returns>
A <see cref="T:System.Int32" /></returns>
</member>
<member name="M:PacketDotNet.WakeOnLanPacket.ToString(PacketDotNet.StringOutputType)">
<summary cref="Packet.ToString(StringOutputType)" />
</member>
<member name="T:PacketDotNet.StringOutputType">
<summary>
The available types of strings that the ToString(StringOutputType) can handle.
</summary>
</member>
<member name="F:PacketDotNet.StringOutputType.Normal">
<summary>
Outputs the packet info on a single line
</summary>
</member>
<member name="F:PacketDotNet.StringOutputType.Colored">
<summary>
Outputs the packet info on a single line with coloring
</summary>
</member>
<member name="F:PacketDotNet.StringOutputType.Verbose">
<summary>
Outputs the detailed packet info
</summary>
</member>
<member name="F:PacketDotNet.StringOutputType.VerboseColored">
<summary>
Outputs the detailed packet info with coloring
</summary>
</member>
<member name="T:PacketDotNet.Tcp.NoOperation">
<summary>
No Operation Option
Used in the TCP Options field to pad the length to the next 32 byte boundary
</summary>
<remarks>
References:
http://datatracker.ietf.org/doc/rfc793/
</remarks>
</member>
<member name="M:PacketDotNet.Tcp.NoOperation.#ctor(System.Byte[],System.Int32,System.Int32)">
<summary>
Creates a No Operation Option
</summary>
<param name="bytes">
A <see cref="T:System.Byte[]" /></param>
<param name="offset">
A <see cref="T:System.Int32" /></param>
<param name="length">
A <see cref="T:System.Int32" /></param>
</member>
<member name="F:PacketDotNet.Tcp.NoOperation.OptionLength">
<summary>
The length (in bytes) of the NoOperation option
</summary>
</member>
<member name="P:PacketDotNet.Tcp.NoOperation.Length">
<summary>
The length of the NoOperation field
Returns 1 as opposed to returning the length field because
the NoOperation option is only 1 byte long and doesn't
contain a length field
</summary>
</member>
<member name="T:PacketDotNet.Tcp.EndOfOptions">
<summary>
End-of-Options Option
Marks the end of the Options list
</summary>
<remarks>
References:
http://datatracker.ietf.org/doc/rfc793/
</remarks>
</member>
<member name="M:PacketDotNet.Tcp.EndOfOptions.#ctor(System.Byte[],System.Int32,System.Int32)">
<summary>
Creates an End Of Options Option
</summary>
<param name="bytes">
A <see cref="T:System.Byte[]" /></param>
<param name="offset">
A <see cref="T:System.Int32" /></param>
<param name="length">
A <see cref="T:System.Int32" /></param>
</member>
<member name="F:PacketDotNet.Tcp.EndOfOptions.OptionLength">
<summary>
The length (in bytes) of the EndOfOptions option
</summary>
</member>
<member name="P:PacketDotNet.Tcp.EndOfOptions.Length">
<summary>
The length of the EndOfOptions field
Returns 1 as opposed to returning the length field because
the EndOfOptions option is only 1 byte long and doesn't
contain a length field
</summary>
</member>
<member name="T:PacketDotNet.Tcp.MaximumSegmentSize">
<summary>
Maximum Segment Size Option
An extension to the DataOffset/HeaderLength field to
allow sizes greater than 65,535
</summary>
<remarks>
References:
http://datatracker.ietf.org/doc/rfc793/
</remarks>
</member>
<member name="M:PacketDotNet.Tcp.MaximumSegmentSize.#ctor(System.Byte[],System.Int32,System.Int32)">
<summary>
Creates a Maximum Segment Size Option
</summary>
<param name="bytes">
A <see cref="T:System.Byte[]" /></param>
<param name="offset">
A <see cref="T:System.Int32" /></param>
<param name="length">
A <see cref="T:System.Int32" /></param>
</member>
<member name="P:PacketDotNet.Tcp.MaximumSegmentSize.Value">
<summary>
The Maximum Segment Size
</summary>
</member>
<member name="M:PacketDotNet.Tcp.MaximumSegmentSize.ToString">
<summary>
Returns the Option info as a string
</summary>
<returns>
A <see cref="T:System.String" /></returns>
</member>
<member name="T:PacketDotNet.Tcp.Option">
<summary>
A TCP Option
</summary>
</member>
<member name="M:PacketDotNet.Tcp.Option.#ctor(System.Byte[],System.Int32,System.Int32)">
<summary>
Creates an Option from a byte[]
</summary>
<param name="bytes">
A <see cref="T:System.Byte[]" /></param>
<param name="offset">
A <see cref="T:System.Int32" /></param>
<param name="length">
A <see cref="T:System.Int32" /></param>
</member>
<member name="F:PacketDotNet.Tcp.Option.KindFieldLength">
<summary>The length (in bytes) of the Kind field</summary>
</member>
<member name="F:PacketDotNet.Tcp.Option.LengthFieldLength">
<summary>The length (in bytes) of the Length field</summary>
</member>
<member name="F:PacketDotNet.Tcp.Option.KindFieldOffset">
<summary>The offset (in bytes) of the Kind Field</summary>
</member>
<member name="F:PacketDotNet.Tcp.Option.LengthFieldOffset">
<summary>The offset (in bytes) of the Length field</summary>
</member>
<member name="P:PacketDotNet.Tcp.Option.Length">
<summary>
The Length of the Option type
</summary>
</member>
<member name="P:PacketDotNet.Tcp.Option.Kind">
<summary>
The Kind of option
</summary>
</member>
<member name="P:PacketDotNet.Tcp.Option.Bytes">
<summary>
Returns a TLV that contains the Option
</summary>
</member>
<member name="M:PacketDotNet.Tcp.Option.ToString">
<summary>
Returns the Option info as a string
</summary>
<returns>
A <see cref="T:System.String" /></returns>
</member>
<member name="T:PacketDotNet.Tcp.WindowScaleFactor">
<summary>
Window Scale Factor Option
Expands the definition of the TCP window to 32 bits
</summary>
<remarks>
References:
http://datatracker.ietf.org/doc/rfc1323/
</remarks>
</member>
<member name="M:PacketDotNet.Tcp.WindowScaleFactor.#ctor(System.Byte[],System.Int32,System.Int32)">
<summary>
Creates a Window Scale Factor Option
</summary>
<param name="bytes">
A <see cref="T:System.Byte[]" /></param>
<param name="offset">
A <see cref="T:System.Int32" /></param>
<param name="length">
A <see cref="T:System.Int32" /></param>
</member>
<member name="P:PacketDotNet.Tcp.WindowScaleFactor.ScaleFactor">
<summary>
The Window Scale Factor
used as a multiplier to the window value
The multiplier is equal to 1 left-shifted by the ScaleFactor
So a scale factor of 7 would equal 1 << 7 = 128
</summary>
</member>
<member name="M:PacketDotNet.Tcp.WindowScaleFactor.ToString">
<summary>
Returns the Option info as a string
The multiplier is equal to a value of 1 left-shifted by the scale factor
</summary>
<returns>
A <see cref="T:System.String" /></returns>
</member>
<member name="T:PacketDotNet.Tcp.OptionTypes">
<summary>
The different types fields that could be found in the Options field
</summary>
<remarks>
References:
http://en.wikipedia.org/wiki/Transmission_Control_Protocol#TCP_Timestamps
http://www.networksorcery.com/enp/default1101.htm
</remarks>
</member>
<member name="F:PacketDotNet.Tcp.OptionTypes.EndOfOptionList">
<summary>End Of List</summary>
<remarks>See RFC 793</remarks>
</member>
<member name="F:PacketDotNet.Tcp.OptionTypes.NoOperation">
<summary>No Operation</summary>
<remarks>See RFC 793</remarks>
</member>
<member name="F:PacketDotNet.Tcp.OptionTypes.MaximumSegmentSize">
<summary>Maximum Segment Size</summary>
<remarks>See RFC 793</remarks>
</member>
<member name="F:PacketDotNet.Tcp.OptionTypes.WindowScaleFactor">
<summary>Window Scale Factor</summary>
<remarks>See RFC 1323</remarks>
</member>
<member name="F:PacketDotNet.Tcp.OptionTypes.SACKPermitted">
<summary>SACK (Selective Ack) Permitted</summary>
<remarks>See RFC 2018</remarks>
</member>
<member name="F:PacketDotNet.Tcp.OptionTypes.SACK">
<summary>SACK (Selective Ack)</summary>
<remarks>See RFC 2018 and RFC 2883</remarks>
</member>
<member name="F:PacketDotNet.Tcp.OptionTypes.Echo">
<summary>Echo (obsolete)</summary>
<remarks>See RFC 1072</remarks>
</member>
<member name="F:PacketDotNet.Tcp.OptionTypes.EchoReply">
<summary>Echo Reply (obsolete)</summary>
<remarks>See RFC 1072</remarks>
</member>
<member name="F:PacketDotNet.Tcp.OptionTypes.Timestamp">
<summary>Timestamp</summary>
<remarks>See RFC 1323</remarks>
</member>
<member name="F:PacketDotNet.Tcp.OptionTypes.POConnectionPermitted">
<summary>Partial Order Connection Permitted (experimental)</summary>
<remarks>See RFC 1693</remarks>
</member>
<member name="F:PacketDotNet.Tcp.OptionTypes.POServiceProfile">
<summary>Partial Order Service Profile (experimental)</summary>
<remarks>See RFC 1693</remarks>
</member>
<member name="F:PacketDotNet.Tcp.OptionTypes.ConnectionCount">
<summary>Connection Count (experimental)</summary>
<remarks>See RFC 1644</remarks>
</member>
<member name="F:PacketDotNet.Tcp.OptionTypes.ConnectionCountNew">
<summary>Connection Count New (experimental)</summary>
<remarks>See RFC 1644</remarks>
</member>
<member name="F:PacketDotNet.Tcp.OptionTypes.ConnectionCountEcho">
<summary>Connection Count Echo (experimental)</summary>
<remarks>See RFC 1644</remarks>
</member>
<member name="F:PacketDotNet.Tcp.OptionTypes.AlternateChecksumRequest">
<summary>Alternate Checksum Request</summary>
<remarks>See RFC 1146</remarks>
</member>
<member name="F:PacketDotNet.Tcp.OptionTypes.AlternateChecksumData">
<summary>Alternate Checksum Data</summary>
<remarks>See RFC 1146</remarks>
</member>
<member name="F:PacketDotNet.Tcp.OptionTypes.MD5Signature">
<summary>MD5 Signature</summary>
<remarks>See RFC 2385</remarks>
</member>
<member name="F:PacketDotNet.Tcp.OptionTypes.QuickStartResponse">
<summary>Quick-Start Response (experimental)</summary>
<remarks>See RFC 4782</remarks>
</member>
<member name="F:PacketDotNet.Tcp.OptionTypes.UserTimeout">
<summary>User Timeout</summary>
<remarks>See RFC 5482</remarks>
</member>
<member name="T:PacketDotNet.Tcp.SACKPermitted">
<summary>
SACK (Selective Ack) Permitted Option
Notifies the receiver that SACK is allowed.
Must only be sent in a SYN segment
</summary>
<remarks>
References:
http://datatracker.ietf.org/doc/rfc2018/
</remarks>
</member>
<member name="M:PacketDotNet.Tcp.SACKPermitted.#ctor(System.Byte[],System.Int32,System.Int32)">
<summary>
Creates a Sack Permitted Option
</summary>
<param name="bytes">
A <see cref="T:System.Byte[]" /></param>
<param name="offset">
A <see cref="T:System.Int32" /></param>
<param name="length">
A <see cref="T:System.Int32" /></param>
</member>
<member name="T:PacketDotNet.Tcp.SACK">
<summary>
SACK (Selective Ack) Option
Provides a means for a receiver to notify the sender about
all the segments that have arrived successfully.
Used to cut down on the number of unnecessary re-transmissions.
</summary>
<remarks>
References:
http://datatracker.ietf.org/doc/rfc2018/
http://datatracker.ietf.org/doc/rfc2883/
</remarks>
</member>
<member name="M:PacketDotNet.Tcp.SACK.#ctor(System.Byte[],System.Int32,System.Int32)">
<summary>
Creates a SACK (Selective Ack) Option
</summary>
<param name="bytes">
A <see cref="T:System.Byte[]" /></param>
<param name="offset">
A <see cref="T:System.Int32" /></param>
<param name="length">
A <see cref="T:System.Int32" /></param>
</member>
<member name="P:PacketDotNet.Tcp.SACK.SACKBlocks">
<summary>
Contains an array of SACK (Selective Ack) Blocks
</summary>
</member>
<member name="M:PacketDotNet.Tcp.SACK.ToString">
<summary>
Returns the Option info as a string
</summary>
<returns>
A <see cref="T:System.String" /></returns>
</member>
<member name="T:PacketDotNet.Tcp.EchoReply">
<summary>
Echo Reply Option
Marked obsolete in the TCP spec Echo Reply Option has been
replaced by the TSOPT (Timestamp Option)
</summary>
<remarks>
References:
http://datatracker.ietf.org/doc/rfc1072/
</remarks>
</member>
<member name="M:PacketDotNet.Tcp.EchoReply.#ctor(System.Byte[],System.Int32,System.Int32)">
<summary>
Creates an Echo Reply Option
</summary>
<param name="bytes">
A <see cref="T:System.Byte[]" /></param>
<param name="offset">
A <see cref="T:System.Int32" /></param>
<param name="length">
A <see cref="T:System.Int32" /></param>
</member>
<member name="T:PacketDotNet.Tcp.TimeStamp">
<summary>
A Time Stamp Option
Used for RTTM (Round Trip Time Measurement)
and PAWS (Protect Against Wrapped Sequences)
Opsoletes the Echo and EchoReply option fields
</summary>
<remarks>
References:
http://datatracker.ietf.org/doc/rfc1323/
</remarks>
</member>
<member name="M:PacketDotNet.Tcp.TimeStamp.#ctor(System.Byte[],System.Int32,System.Int32)">
<summary>
Creates a Timestamp Option
</summary>
<param name="bytes">
A <see cref="T:System.Byte[]" /></param>
<param name="offset">
A <see cref="T:System.Int32" /></param>
<param name="length">
A <see cref="T:System.Int32" /></param>
</member>
<member name="P:PacketDotNet.Tcp.TimeStamp.Value">
<summary>
The Timestamp value
</summary>
</member>
<member name="P:PacketDotNet.Tcp.TimeStamp.EchoReply">
<summary>
The Echo Reply
</summary>
</member>
<member name="M:PacketDotNet.Tcp.TimeStamp.ToString">
<summary>
Returns the Option info as a string
</summary>
<returns>
A <see cref="T:System.String" /></returns>
</member>
<member name="T:PacketDotNet.Tcp.Echo">
<summary>
An Echo Option
throws an exception because Echo Options
are obsolete as per their spec
</summary>
</member>
<member name="M:PacketDotNet.Tcp.Echo.#ctor(System.Byte[],System.Int32,System.Int32)">
<summary>
Creates an Echo Option
</summary>
<param name="bytes">
A <see cref="T:System.Byte[]" /></param>
<param name="offset">
A <see cref="T:System.Int32" /></param>
<param name="length">
A <see cref="T:System.Int32" /></param>
</member>
<member name="T:PacketDotNet.Tcp.AlternateChecksumRequest">
<summary>
AlternateChecksumRequest Option
</summary>
</member>
<member name="M:PacketDotNet.Tcp.AlternateChecksumRequest.#ctor(System.Byte[],System.Int32,System.Int32)">
<summary>
Creates an Alternate Checksum Request Option
Used to negotiate an alternative checksum algorithm in a connection
</summary>
<param name="bytes">
A <see cref="T:System.Byte[]" /></param>
<param name="offset">
A <see cref="T:System.Int32" /></param>
<param name="length">
A <see cref="T:System.Int32" /></param>
<remarks>
References:
http://datatracker.ietf.org/doc/rfc1146/
</remarks>
</member>
<member name="P:PacketDotNet.Tcp.AlternateChecksumRequest.Checksum">
<summary>
The Checksum
</summary>
</member>
<member name="M:PacketDotNet.Tcp.AlternateChecksumRequest.ToString">
<summary>
Returns the Option info as a string
</summary>
<returns>
A <see cref="T:System.String" /></returns>
</member>
<member name="T:PacketDotNet.Tcp.ChecksumAlgorighmType">
<summary>
Specifies the different types of algorithms that the
Alternative Checksum option are allowed to use
</summary>
<remarks>
References:
http://datatracker.ietf.org/doc/rfc1146/
</remarks>
</member>
<member name="F:PacketDotNet.Tcp.ChecksumAlgorighmType.TCPChecksum">
<summary>Standard TCP Checksum Algorithm</summary>
</member>
<member name="F:PacketDotNet.Tcp.ChecksumAlgorighmType.EightBitFletchersAlgorithm">
<summary>8-bit Fletchers Algorighm</summary>
</member>
<member name="F:PacketDotNet.Tcp.ChecksumAlgorighmType.SixteenBitFletchersAlgorithm">
<summary>16-bit Fletchers Algorithm</summary>
</member>
<member name="F:PacketDotNet.Tcp.ChecksumAlgorighmType.RedundantChecksumAvoidance">
<summary>Redundant Checksum Avoidance</summary>
</member>
<member name="T:PacketDotNet.Tcp.AlternateChecksumData">
<summary>
Alternative Checksum Date
Used as an extension to Alternative Checksum Response when the
checksum is longer than the standard 16bit TCP Checksum field
</summary>
<remarks>
References:
http://datatracker.ietf.org/doc/rfc1146/
</remarks>
</member>
<member name="M:PacketDotNet.Tcp.AlternateChecksumData.#ctor(System.Byte[],System.Int32,System.Int32)">
<summary>
Creates an Alternate Checksum Data Option
</summary>
<param name="bytes">
A <see cref="T:System.Byte[]" /></param>
<param name="offset">
A <see cref="T:System.Int32" /></param>
<param name="length">
A <see cref="T:System.Int32" /></param>
</member>
<member name="P:PacketDotNet.Tcp.AlternateChecksumData.Data">
<summary>
The array of attached Checksum
</summary>
</member>
<member name="M:PacketDotNet.Tcp.AlternateChecksumData.ToString">
<summary>
Returns the Option info as a string
</summary>
<returns>
A <see cref="T:System.String" /></returns>
</member>
<member name="T:PacketDotNet.Tcp.MD5Signature">
<summary>
MD5 Signature
Carries the MD5 Digest used by the BGP protocol to
ensure security between two endpoints
</summary>
<remarks>
References:
http://datatracker.ietf.org/doc/rfc2385/
</remarks>
</member>
<member name="M:PacketDotNet.Tcp.MD5Signature.#ctor(System.Byte[],System.Int32,System.Int32)">
<summary>
Creates a MD5 Signature Option
</summary>
<param name="bytes">
A <see cref="T:System.Byte[]" /></param>
<param name="offset">
A <see cref="T:System.Int32" /></param>
<param name="length">
A <see cref="T:System.Int32" /></param>
</member>
<member name="P:PacketDotNet.Tcp.MD5Signature.MD5Digest">
<summary>
The MD5 Digest
</summary>
</member>
<member name="M:PacketDotNet.Tcp.MD5Signature.ToString">
<summary>
Returns the Option info as a string
</summary>
<returns>
A <see cref="T:System.String" /></returns>
</member>
<member name="T:PacketDotNet.Tcp.UserTimeout">
<summary>
User Timeout Option
The TCP user timeout controls how long transmitted data may remain
unacknowledged before a connection is forcefully closed
</summary>
<remarks>
References:
http://datatracker.ietf.org/doc/rfc5482/
</remarks>
</member>
<member name="M:PacketDotNet.Tcp.UserTimeout.#ctor(System.Byte[],System.Int32,System.Int32)">
<summary>
Creates a User Timeout Option
</summary>
<param name="bytes">
A <see cref="T:System.Byte[]" /></param>
<param name="offset">
A <see cref="T:System.Int32" /></param>
<param name="length">
A <see cref="T:System.Int32" /></param>
</member>
<member name="P:PacketDotNet.Tcp.UserTimeout.Granularity">
<summary>
The Granularity
</summary>
</member>
<member name="P:PacketDotNet.Tcp.UserTimeout.Timeout">
<summary>
The User Timeout
</summary>
</member>
<member name="M:PacketDotNet.Tcp.UserTimeout.ToString">
<summary>
Returns the Option info as a string
</summary>
<returns>
A <see cref="T:System.String" /></returns>
</member>
</members>
</doc>
|
