GOG GALAXY SDK Documentation
InitOptions Struct Reference

The group of options used for Init configuration. More...

#include <InitOptions.h>

Public Member Functions

 InitOptions (const char *_clientID, const char *_clientSecret, const char *_configFilePath=".", GalaxyAllocator *_galaxyAllocator=NULL, const char *_storagePath=NULL, const char *_host=NULL, uint16_t _port=0, IGalaxyThreadFactory *_galaxyThreadFactory=NULL)
 InitOptions constructor. More...
 

Public Attributes

const char * clientID
 The ID of the client.
 
const char * clientSecret
 The secret of the client.
 
const char * configFilePath
 The path to folder which contains configuration files.
 
const char * storagePath
 The path to folder for storing internal SDK data. Used only on Android devices.
 
GalaxyAllocator * galaxyAllocator
 The custom memory allocator used by GOG Galaxy SDK.
 
IGalaxyThreadFactory * galaxyThreadFactory
 The custom thread factory used by GOG Galaxy SDK to spawn internal threads.
 
const char * host
 The local IP address this peer would bind to.
 
uint16_t port
 The local port used to communicate with GOG Galaxy Multiplayer server and other players.
 

Detailed Description

The group of options used for Init configuration.

Constructor & Destructor Documentation

◆ InitOptions()

InitOptions ( const char *  _clientID,
const char *  _clientSecret,
const char *  _configFilePath = ".",
GalaxyAllocator *  _galaxyAllocator = NULL,
const char *  _storagePath = NULL,
const char *  _host = NULL,
uint16_t  _port = 0,
IGalaxyThreadFactory *  _galaxyThreadFactory = NULL 
)
inline

InitOptions constructor.

Remarks
On Android device Galaxy SDK needs a directory for internal storage (to keep a copy of system CA certificates). It should be an existing directory within the application file storage.
Parameters
[in]_clientIDThe ID of the client.
[in]_clientSecretThe secret of the client.
[in]_configFilePathThe path to a folder which contains configuration files. Note: a relative path is relative to the current working directory, but not to an executable.
[in]_galaxyAllocatorThe custom memory allocator. The same instance has to be passed to both Galaxy Peer and Game Server.
[in]_storagePathPath to a directory that can be used for storing internal SDK data. Used only on Android devices. See remarks for more information.
[in]_hostThe local IP address this peer would bind to.
[in]_portThe local port used to communicate with GOG Galaxy Multiplayer server and other players.
[in]_galaxyThreadFactoryThe custom thread factory used by GOG Galaxy SDK to spawn internal threads.