Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
The primary management class for interacting with the Party library.
Syntax
class PartyManager
Public Methods
| Name | Description |
|---|---|
| GetSingleton | Retrieves a reference to the PartyManager singleton instance. |
| SetOption | Configures an option to fine-tune Party library functionality. |
| GetOption | Retrieves an option used to fine-tune Party library functionality. |
| GetErrorMessage | Get the human-readable form of an error generated by the Party library. |
| SerializeNetworkDescriptor | Serializes a network descriptor structure into an opaque string that is safe to communicate over title and platform-specific communication channels. |
| DeserializeNetworkDescriptor | Deserializes a network descriptor structure from an opaque string serialized via a prior call to SerializeNetworkDescriptor(). |
| SetMemoryCallbacks | Optionally configures the memory allocation and freeing callbacks the Party library should use. |
| GetMemoryCallbacks | Retrieves the memory allocation and freeing callbacks the Party library is using. |
| SetProfilingCallbacksForMethodEntryExit | Optionally configures the profiling event callbacks the Party library will make when entering or exiting instrumented methods. |
| GetProfilingCallbacksForMethodEntryExit | Retrieves the profiling event callbacks the Party library is configured to use when entering or exiting instrumented methods. |
| SetThreadAffinityMask | Optionally configures the processor on which internal Party library threads run. |
| GetThreadAffinityMask | Retrieves the current set of processors on which internal Party library threads will run or are running as an affinity mask. |
| SetWorkMode | Configures the work mode of the Party library processing task associated with threadId. |
| GetWorkMode | Retrieves the current work mode of the Party library's internal processing task associated with threadId. |
| Initialize | Initializes the PartyManager object instance. |
| Cleanup | Immediately reclaims all resources associated with all Party library objects. |
| StartProcessingStateChanges | Retrieves an array of all PartyStateChanges to process since the last such call. |
| FinishProcessingStateChanges | Returns an array of PartyStateChanges that were being processed. |
| DoWork | Synchronously performs the processing task associated with threadId. |
| GetRegions | Gets an array containing the set of regions for which your title is configured, along with round trip latency information. |
| CreateNewNetwork | Queues an asynchronous attempt to create a new network. |
| ConnectToNetwork | Queues an asynchronous attempt to connect to a network. |
| GetLocalDevice | Gets the local device. |
| CreateLocalUser | Creates a local user object that is used to represent a local player when performing networking and chat operations. |
| CreateLocalUserWithEntityType | Creates a local user object that is used to represent a supported PlayFab Entity ID and type when performing networking and chat operations. |
| DestroyLocalUser | Starts an asynchronous operation to destroy a local user. |
| GetLocalUsers | Gets an array containing all local users created by CreateLocalUser() or CreateLocalUserWithEntityType(). |
| GetNetworks | Gets an array of all networks to which the local device is connected or connecting. |
| GetChatControls | Gets an array that contains a combined list of all chat controls on the local device and all remote devices. |
Remarks
Only a single instance of the class is permitted.
Requirements
Header: Party.h