PowerShellUDPModule.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>PowerShellUDPModule</name>
    </assembly>
    <members>
        <member name="M:PowerShell.UDP.GetUdpListenerCommand.BeginProcessing">
            <inheritdoc/>
        </member>
        <member name="T:PowerShell.UDP.NewUdpListenerCommand">
            <summary>
            <para type="synopsis">Creates a new object.</para>
            <para type="description"> objects are used to listen for client requests.</para>
            </summary>
        </member>
        <member name="P:PowerShell.UDP.NewUdpListenerCommand.Port">
            <summary>
            <para type="description">The port to listen on.</para>
            </summary>
        </member>
        <member name="M:PowerShell.UDP.NewUdpListenerCommand.ProcessRecord">
            <inheritdoc/>
        </member>
        <member name="T:PowerShell.UDP.SendUdpRequestCommand">
            <summary>
            <para type="synopsis"></para>
            <para type="description"></para>
            </summary>
        </member>
        <member name="P:PowerShell.UDP.SendUdpRequestCommand.ServerPort">
            <summary>
            <para type="description">The port to send datagram to.</para>
            </summary>
        </member>
        <member name="P:PowerShell.UDP.SendUdpRequestCommand.ServerIpEndPoint">
            <summary>
            <para type="description">
            An <see cref="T:System.Net.IPEndPoint"/> specifying the server to send to.
            Default: IPEndPoint(IpAddress.Broadcast, 11000) # sends datagrams for broadcast on 11000.
            </para>
            </summary>
        </member>
        <member name="P:PowerShell.UDP.SendUdpRequestCommand.RawDatagram">
            <summary>
            <para type="description">The raw data to send.</para>
            </summary>
        </member>
        <member name="P:PowerShell.UDP.SendUdpRequestCommand.UTF8Datagram">
            <summary>
            <para type="description">The data to send (in UTF8).</para>
            </summary>
        </member>
        <member name="P:PowerShell.UDP.SendUdpRequestCommand.Client">
            <summary>
            <see cref="T:System.Net.Sockets.UdpClient"/>
            </summary>
            <remarks>send does not need local port</remarks>
        </member>
        <member name="M:PowerShell.UDP.SendUdpRequestCommand.BeginProcessing">
            <inheritdoc/>
        </member>
        <member name="M:PowerShell.UDP.SendUdpRequestCommand.ProcessRecord">
            <inheritdoc/>
        </member>
        <member name="M:PowerShell.UDP.SendUdpRequestCommand.EndProcessing">
            <inheritdoc/>
        </member>
        <member name="P:PowerShell.UDP.StopUdpListenerCommand.Listener">
            <summary>
            <para type="description">Used to listen for client requests.</para>
            </summary>
        </member>
        <member name="M:PowerShell.UDP.StopUdpListenerCommand.ProcessRecord">
            <inheritdoc/>
        </member>
        <member name="T:PowerShell.UDP.UdpRequest">
            <summary>
            Container for a <see cref="T:System.Net.Sockets.UdpClient"/> request.
            </summary>
        </member>
        <member name="P:PowerShell.UDP.UdpRequest.Client">
            <summary>
            Client who sent the datagram.
            </summary>
        </member>
        <member name="P:PowerShell.UDP.UdpRequest.RawPayload">
            <summary>
            The datagram content.
            This will need to be parsed according to its expected format.
            </summary>
        </member>
        <member name="P:PowerShell.UDP.UdpRequest.UTF8Payload">
            <summary>
            The datagram content parsed into UTF8.
            </summary>
        </member>
        <member name="T:PowerShell.UDP.WaitUdpRequestCommand">
            <summary>
            <para type="synopsis">Creates a new object.</para>
            <para type="description"> objects are used to listen for client requests.</para>
            </summary>
        </member>
        <member name="P:PowerShell.UDP.WaitUdpRequestCommand.Listener">
            <summary>
            <para type="description">Used to listen for client requests.</para>
            </summary>
        </member>
        <member name="P:PowerShell.UDP.WaitUdpRequestCommand.ClientIpEndPoint">
            <summary>
            <para type="description">
            An <see cref="T:System.Net.IPEndPoint"/> specifying what senders to receive from.
            Default: IPEndPoint(IpAddress.Any, 0) # receives datagrams sent from any source.
            </para>
            </summary>
        </member>
        <member name="P:PowerShell.UDP.WaitUdpRequestCommand.NumberOfRequests">
            <summary>
            <para type="description">Number of requests to listen for before exiting the listener loop.</para>
            </summary>
        </member>
        <member name="P:PowerShell.UDP.WaitUdpRequestCommand.InfiniteRequests">
            <summary>
            <para type="description">Never stop the listener loop.</para>
            <para type="description">WARNING: be careful of how you are using this because it results in an infinite blocking loop.</para>
            </summary>
        </member>
        <member name="M:PowerShell.UDP.WaitUdpRequestCommand.BeginProcessing">
            <inheritdoc/>
        </member>
        <member name="M:PowerShell.UDP.WaitUdpRequestCommand.ProcessRecord">
            <inheritdoc/>
        </member>
    </members>
</doc>