interface INetworkGroup (Niantic.ARDK.Networking.HLAPI.INetworkGroup)

Overview

A group of information to be replicated over the network. Can loosely be thought of as an "object" - it handles a number of registered data handlers, which all have a lifetime that is tied to this group. More...

interface INetworkGroup: Niantic.ARDK.Networking.HLAPI.INetworkedDataHandler {
    // properties

    NetworkId NetworkId;
    IHlapiSession Session;

    // methods

    INetworkGroup CreateNestedGroup(NetworkId groupId);

    void ReceiveCachedDataFromSession(
        IHlapiSession session,
        UnhandledPacketCache cache
    );

    void RegisterHandler(INetworkedDataHandler handler);
    void UnregisterHandler(INetworkedDataHandler handler);
};

// direct descendants

class NetworkGroup;

Inherited Members

public:
    // properties

    INetworkGroup Group;
    string Identifier;

    // methods

    void Unregister();

Detailed Documentation

A group of information to be replicated over the network. Can loosely be thought of as an "object" - it handles a number of registered data handlers, which all have a lifetime that is tied to this group.

Properties

NetworkId NetworkId

The NetworkId representing this group

IHlapiSession Session

The IHlapiSession object that this group is attached to.

Methods

INetworkGroup CreateNestedGroup(NetworkId groupId)

Creates a new nested group that is attached to this group.

Parameters:

groupId

Unique identifier for this group, equivalent to a ulong

void ReceiveCachedDataFromSession(
    IHlapiSession session,
    UnhandledPacketCache cache
)

Initialize the Session and receive any cached data addressed to this NetworkGroup. This will generally be called by the HlapiSession

Parameters:

session
cache

void RegisterHandler(INetworkedDataHandler handler)

Register an INetworkedDataHandler to this group, which will handler sending/receiving data as well as routing.

Parameters:

handler

void UnregisterHandler(INetworkedDataHandler handler)

Unregisters a handler from this group, such that it will no longer send/receive data. However, the handler itself is not destroyed by this call.

Parameters:

handler