LocalNetworkGamer.ReceiveData Method (PacketReader, NetworkGamer)

Reads the next incoming packet and copies the packet data into the specified reader object.

Namespace: Microsoft.Xna.Framework.Net
Assembly: Microsoft.Xna.Framework.Net (in microsoft.xna.framework.net.dll)

public int ReceiveData (
         PacketReader data,
         out NetworkGamer sender


Type: PacketReader
Network packet data.
Type: NetworkGamer
[OutAttribute] Gamer who sent this packet.

Return Value

Number of bytes read from the network packet. Returns 0 if no packet is available.

Exception typeCondition
ArgumentExceptionThe specified array is too small to receive the incoming network packet.
ArgumentNullException data is null.

Be sure to call ReceiveData for all incoming data for all local gamers, even if the data is to be discarded. Any time data is sent to a local network gamer, the incoming data queue will grow until the data is read. If the data is not read using ReceiveData the performance of the application will degrade as the data queue grows in size.

foreach (LocalNetworkGamer gamer in session.LocalGamers)
    // Keep reading while packets are available.
    while (gamer.IsDataAvailable)
        NetworkGamer sender;

        // Read a single packet.
        gamer.ReceiveData(packetReader, out sender);
        // Discard the data, or use packetReader.Read* to process the data.
    gamer.SendData(packetWriter, SendDataOptions.None);

If several independent packets are available, only one will be returned on each call to ReceiveData.

Xbox 360, Windows 7, Windows Vista, Windows XP

Community Additions