#include <SharedConnectionFilterStatus.h>

Public Member Functions
IRISCORE_API bool	SetFilterStatus (FConnectionHandle ConnectionHandle, ENetFilterStatus FilterStatus)

ENetFilterStatus	GetFilterStatus () const

IRISCORE_API void	RemoveConnection (FConnectionHandle ConnectionHandle)

uint32	GetParentConnectionId () const

Detailed Description

Keeps track of the filter status for a connection and its child connections. All FConnectionHandles must have the same ParentConnection. As soon as the filter status is set for a FConnectionHandle all subsequent operations must have the same FConnectionHandle. The default state is that the filter status is Disallowed. If there's at least one connection that has set the filter status to Allowed then will the filter status for the group be Allowed.

Member Function Documentation

◆ GetFilterStatus()

ENetFilterStatus UE::Net::FSharedConnectionFilterStatus::GetFilterStatus ( ) const

inline

Returns Disallowed if no connections have set the filter status to Allowed and returns Allowed otherwise.

◆ GetParentConnectionId()

uint32 UE::Net::FSharedConnectionFilterStatus::GetParentConnectionId ( ) const

inline

Returns the parent connection ID the group operates on or InvalidConnectionId if no valid connection handles ever set filter status.

◆ RemoveConnection()

void UE::Net::FSharedConnectionFilterStatus::RemoveConnection ( FConnectionHandle ConnectionHandle )

Removes the filter status for ConnectionHandle. If it's a parent connection it will act as if all child connections were removed too and allow the instance to be used with a different ParentConnectionId.

◆ SetFilterStatus()

bool UE::Net::FSharedConnectionFilterStatus::SetFilterStatus	(	FConnectionHandle	ConnectionHandle,
		ENetFilterStatus	FilterStatus
	)

Returns true if the filter status could be successfully set for the ConnectionHandle. A return value of false indicates either the connection handle is invalid or its ParentConnectionId doesn't match prior calls to SetFilterStatus.

The documentation for this class was generated from the following files: