Collaboration diagram for Peer:

Functions
GALAXY_DLL_EXPORT void GALAXY_CALLTYPE	Init (const InitOptions &initOptions)
	Initializes the Galaxy Peer with specified credentials. More...

GALAXY_DLL_EXPORT void GALAXY_CALLTYPE	Shutdown ()
	Shuts down the Galaxy Peer. More...

GALAXY_DLL_EXPORT void GALAXY_CALLTYPE	ShutdownEx (const ShutdownOptions &shutdownOptions)
	Shuts down the Galaxy Peer. More...

GALAXY_DLL_EXPORT IUser *GALAXY_CALLTYPE	User ()
	Returns an instance of IUser. More...

GALAXY_DLL_EXPORT IFriends *GALAXY_CALLTYPE	Friends ()
	Returns an instance of IFriends. More...

GALAXY_DLL_EXPORT IChat *GALAXY_CALLTYPE	Chat ()
	Returns an instance of IChat. More...

GALAXY_DLL_EXPORT IMatchmaking *GALAXY_CALLTYPE	Matchmaking ()
	Returns an instance of IMatchmaking. More...

GALAXY_DLL_EXPORT INetworking *GALAXY_CALLTYPE	Networking ()
	Returns an instance of INetworking that allows to communicate as a regular lobby member. More...

GALAXY_DLL_EXPORT IStats *GALAXY_CALLTYPE	Stats ()
	Returns an instance of IStats. More...

GALAXY_DLL_EXPORT IUtils *GALAXY_CALLTYPE	Utils ()
	Returns an instance of IUtils. More...

GALAXY_DLL_EXPORT IApps *GALAXY_CALLTYPE	Apps ()
	Returns an instance of IApps. More...

GALAXY_DLL_EXPORT IStorage *GALAXY_CALLTYPE	Storage ()
	Returns an instance of IStorage. More...

GALAXY_DLL_EXPORT ICustomNetworking *GALAXY_CALLTYPE	CustomNetworking ()
	Returns an instance of ICustomNetworking. More...

GALAXY_DLL_EXPORT ILogger *GALAXY_CALLTYPE	Logger ()
	Returns an instance of ILogger. More...

GALAXY_DLL_EXPORT ITelemetry *GALAXY_CALLTYPE	Telemetry ()
	Returns an instance of ITelemetry. More...

GALAXY_DLL_EXPORT ICloudStorage *GALAXY_CALLTYPE	CloudStorage ()
	Returns an instance of ICloudStorage. More...

GALAXY_DLL_EXPORT void GALAXY_CALLTYPE	ProcessData ()
	Makes the Galaxy Peer process its input and output streams. More...

GALAXY_DLL_EXPORT IListenerRegistrar *GALAXY_CALLTYPE	ListenerRegistrar ()
	Returns an instance of IListenerRegistrar. More...

Detailed Description

Function Documentation

◆ Apps()

GALAXY_DLL_EXPORT IApps* GALAXY_CALLTYPE galaxy::api::Apps ( )

Returns an instance of IApps.

Returns: An instance of IApps.

◆ Chat()

GALAXY_DLL_EXPORT IChat* GALAXY_CALLTYPE galaxy::api::Chat ( )

Returns an instance of IChat.

Returns: An instance of IChat.

◆ CloudStorage()

GALAXY_DLL_EXPORT ICloudStorage* GALAXY_CALLTYPE galaxy::api::CloudStorage ( )

Returns an instance of ICloudStorage.

Returns: An instance of ICloudStorage.

◆ CustomNetworking()

GALAXY_DLL_EXPORT ICustomNetworking* GALAXY_CALLTYPE galaxy::api::CustomNetworking ( )

Returns an instance of ICustomNetworking.

Returns: An instance of ICustomNetworking.

◆ Friends()

GALAXY_DLL_EXPORT IFriends* GALAXY_CALLTYPE galaxy::api::Friends ( )

Returns an instance of IFriends.

Returns: An instance of IFriends.

◆ Init()

GALAXY_DLL_EXPORT void GALAXY_CALLTYPE galaxy::api::Init ( const InitOptions & initOptions )

Initializes the Galaxy Peer with specified credentials.

Remarks: When you do not need the Galaxy Peer anymore, you should call Shutdown() in order to deactivate it and free its resources.; This method can succeed partially, in which case it leaves Galaxy Peer partially functional, hence even in case of an error, be sure to call Shutdown() when you do not need the Galaxy Peer anymore. See the documentation of specific interfaces on how they behave.

Parameters

[in] initOptions The group of the init options.

◆ ListenerRegistrar()

GALAXY_DLL_EXPORT IListenerRegistrar* GALAXY_CALLTYPE galaxy::api::ListenerRegistrar ( )

Returns an instance of IListenerRegistrar.

Returns: An instance of IListenerRegistrar.

◆ Logger()

GALAXY_DLL_EXPORT ILogger* GALAXY_CALLTYPE galaxy::api::Logger ( )

Returns an instance of ILogger.

Returns: An instance of ILogger.

◆ Matchmaking()

GALAXY_DLL_EXPORT IMatchmaking* GALAXY_CALLTYPE galaxy::api::Matchmaking ( )

Returns an instance of IMatchmaking.

Returns: An instance of IMatchmaking.

◆ Networking()

GALAXY_DLL_EXPORT INetworking* GALAXY_CALLTYPE galaxy::api::Networking ( )

Returns an instance of INetworking that allows to communicate as a regular lobby member.

Returns: An instance of INetworking.

◆ ProcessData()

GALAXY_DLL_EXPORT void GALAXY_CALLTYPE galaxy::api::ProcessData ( )

Makes the Galaxy Peer process its input and output streams.

During the phase of processing data, Galaxy Peer recognizes specific events and casts notifications for callback listeners immediately.

This method should be called in a loop, preferably every frame, so that Galaxy is able to process input and output streams.

Remarks: When this method is not called, any asynchronous calls to Galaxy API cannot be processed and any listeners will not be properly called.

◆ Shutdown()

GALAXY_DLL_EXPORT void GALAXY_CALLTYPE galaxy::api::Shutdown ( )

Shuts down the Galaxy Peer.

The Galaxy Peer is deactivated and brought to the state it had when it was created and before it was initialized.

Precondition: Delete all self-registering listeners before calling Shutdown().

◆ ShutdownEx()

GALAXY_DLL_EXPORT void GALAXY_CALLTYPE galaxy::api::ShutdownEx ( const ShutdownOptions & shutdownOptions )

Shuts down the Galaxy Peer.

The Galaxy Peer is deactivated and brought to the state it had when it was created and before it was initialized.

Precondition: Delete all self-registering listeners before calling ShutdownEx().

Parameters

[in] shutdownOptions The group of the shutdown options.

◆ Stats()

GALAXY_DLL_EXPORT IStats* GALAXY_CALLTYPE galaxy::api::Stats ( )

Returns an instance of IStats.

Returns: An instance of IStats.

◆ Storage()

GALAXY_DLL_EXPORT IStorage* GALAXY_CALLTYPE galaxy::api::Storage ( )

Returns an instance of IStorage.

Returns: An instance of IStorage.

◆ Telemetry()

GALAXY_DLL_EXPORT ITelemetry* GALAXY_CALLTYPE galaxy::api::Telemetry ( )

Returns an instance of ITelemetry.

Returns: An instance of ITelemetry.

◆ User()

GALAXY_DLL_EXPORT IUser* GALAXY_CALLTYPE galaxy::api::User ( )

Returns an instance of IUser.

Returns: An instance of IUser.

◆ Utils()

GALAXY_DLL_EXPORT IUtils* GALAXY_CALLTYPE galaxy::api::Utils ( )

Returns an instance of IUtils.

Returns: An instance of IUtils.

Functions