Class Client

This is a double-ended queue of confirmed PacketIDs, representing received ReliablePackets.

This field is protected, but is documented for extension purposes.

This is a "timer" (Point in time) used to calculate the amount of time between PacketID releases from ConfirmedPackets.

This field is protected, but is documented for extension purposes.

This is a collection of "waiting" (Remotely created) MegaPacket objects.

This field is protected, but is documented for extension purposes.

Constructors for Client objects are handled internally, and should only be used when extending this framework. This overload is used for protocols that are address-based, rather than socket-based. (UDP) That being said, this is also used internally by client NetworkEngine objects, for Remote (Only Client instance).

• The Address argument specifies the remote address of the client.
• The Connection argument is mainly available for debugging purposes / internal use.
• The PacketConfirmation argument is described in Construct_Client.

Constructors for Client objects are handled internally, and should only be used when extending this framework. This overload is used for protocols that are socket-based, rather than address-based. (TCP)

• The Connection argument is used to describe the Socket associated with this client.
• The PacketConfirmation argument is described in Construct_Client.

The address associated with this client; may be Null depending on the underlying transport protocol. (Available for UDP) See also: New

This specifies if this client handle has been closed by a network and/or user.

This specifies if this client is in the process of disconnecting/closing. (Ignored for formal messages; only internal messages will be accepted)

Use caution when setting this property-overload. (Handled internally, use at your own risk)

The Socket associated with this client; may be Null depending on the underlying transport protocol. (Available for TCP)

This corresponds to the constructor argument of the same name. See also: New, Construct_Client

This specifies the last known ping of this client. This does not change while calculating a new ping.

The last point in time used when pinging began. This property has protected assignment-access. See also: Pinging, Ping

This specifies if this client is currently calculating a ping. The Ping property is still valid while this is True. This property has protected assignment-access.

This adds MP to an internal container for "waiting" (Remote) MegaPacket objects.

This method is protected, but is documented for extension purposes.

This assigns this client's ping using ProjectedPing, resets the internal "ping timer", then resets the Pinging flag.

This method is protected, but is documented for extension purposes.

This destructor is used internally. Please disconnect clients through their parent NetworkEngine objects. This will close a Socket if held by this object, invalidate the Address property, release any associated packet identifiers, release held MegaPacket handles, and set relevant closure-flags.

This will confirm packets with ID as their identifier, but only if it hasn't already been identified. The return-value indicates if the operation failed.

This is an internal constructor used when constructing Client objects.

• The PacketConfirmation argument specifies if this Client will be keeping track of packet identifiers. (Non-reliable protocols)

This returns True if ID has already been confirmed. See also: ConfirmPacket, Update

This retrieves a "waiting" MegaPacket object with ID.

For details, view the AddWaitingMegaPacket method's documentation.

This method is protected, but is documented for extension purposes.

This states if a MegaPacket object with ID is inside this object's "waiting mega-packets" container.

This method is protected, but is documented for extension purposes.

This returns the "projected ping" of this client, based on the criteria specified in Network. "Projected pings" are approximate pings describing how long a client has been pinging. This number is not accurate unless the Pinging property reports True.

This is an internal method that will automatically release the next packet identifier in the queue.

This method is protected, but is documented for extension purposes.

This is used to remove MP from an internal container of "waiting" (Client-created) MegaPackets.

This method is protected, but is documented for extension purposes.

This removes a "waiting" MegaPacket with ID; calls the main implementation.

This method is protected, but is documented for extension purposes.

This resets the internal "packet timer", used for releasing reliable-packet identifiers.

This method is protected, but is documented for extension purposes.

This resets an internal timer used for ping calculation.

This method is protected, but is documented for extension purposes.

This is used to update a Client object. The main purpose of this is to handle reliable packet identifiers.

But this also handles ping calculation and MegaPacket handles.

This updates any waiting MegaPacket handles; handles timeout semantics.

This is called internally by Update.