GOG GALAXY SDK Documentation
Api
Collaboration diagram for Api:

Modules

 Peer
 
 GameServer
 

Classes

class  IError
 Base interface for exceptions. More...
 
class  IUnauthorizedAccessError
 The exception thrown when calling Galaxy interfaces while the user is not signed in and thus not authorized for any interaction. More...
 
class  IInvalidArgumentError
 The exception thrown to report that a method was called with an invalid argument. More...
 
class  IInvalidStateError
 The exception thrown to report that a method was called while the callee is in an invalid state, i.e. More...
 
class  IRuntimeError
 The exception thrown to report errors that can only be detected during runtime. More...
 
struct  GalaxyAllocator
 Custom memory allocator for GOG Galaxy SDK. More...
 
class  GalaxyID
 Represents the ID of an entity used by Galaxy Peer. More...
 
class  IGalaxyThread
 The interface representing a thread object. More...
 
class  IGalaxyThreadFactory
 Custom thread spawner for the Galaxy SDK. More...
 
class  IApps
 The interface for managing application activities. More...
 
class  IChatRoomWithUserRetrieveListener
 Listener for the event of retrieving a chat room with a specified user. More...
 
class  IChatRoomMessageSendListener
 Listener for the event of sending a chat room message. More...
 
class  IChatRoomMessagesListener
 Listener for the event of receiving chat room messages. More...
 
class  IChatRoomMessagesRetrieveListener
 Listener for the event of retrieving chat room messages in a specified chat room. More...
 
class  IChat
 The interface for chat communication with other Galaxy Users. More...
 
class  IConnectionOpenListener
 Listener for the events related to opening a connection. More...
 
class  IConnectionCloseListener
 Listener for the event of closing a connection. More...
 
class  IConnectionDataListener
 Listener for the event of receiving data over the connection. More...
 
class  ICustomNetworking
 The interface for communicating with a custom endpoint. More...
 
class  IPersonaDataChangedListener
 Listener for the event of changing persona data. More...
 
class  IUserInformationRetrieveListener
 Listener for the event of retrieving requested user's information. More...
 
class  IFriendListListener
 Listener for the event of retrieving requested list of friends. More...
 
class  IFriendInvitationSendListener
 Listener for the event of sending a friend invitation. More...
 
class  IFriendInvitationListRetrieveListener
 Listener for the event of retrieving requested list of incoming friend invitations. More...
 
class  ISentFriendInvitationListRetrieveListener
 Listener for the event of retrieving requested list of outgoing friend invitations. More...
 
class  IFriendInvitationListener
 Listener for the event of receiving a friend invitation. More...
 
class  IFriendInvitationRespondToListener
 Listener for the event of responding to a friend invitation. More...
 
class  IFriendAddListener
 Listener for the event of a user being added to the friend list. More...
 
class  IFriendDeleteListener
 Listener for the event of removing a user from the friend list. More...
 
class  IRichPresenceChangeListener
 Listener for the event of rich presence modification. More...
 
class  IRichPresenceListener
 Listener for the event of any user rich presence update. More...
 
class  IRichPresenceRetrieveListener
 Listener for the event of retrieving requested user's rich presence. More...
 
class  IGameJoinRequestedListener
 Event of requesting a game join by user. More...
 
class  IGameInvitationReceivedListener
 Event of receiving a game invitation. More...
 
class  ISendInvitationListener
 Listener for the event of sending an invitation without using the overlay. More...
 
class  IUserFindListener
 Listener for the event of searching a user. More...
 
class  IFriends
 The interface for managing social info and activities. More...
 
class  IGalaxyListener
 The interface that is implemented by all specific callback listeners. More...
 
class  GalaxyTypeAwareListener< type >
 The class that is inherited by all specific callback listeners and provides a static method that returns the type of the specific listener. More...
 
class  IListenerRegistrar
 The class that enables and disables global registration of the instances of specific listeners. More...
 
class  SelfRegisteringListener< _TypeAwareListener, _Registrar >
 The class that is inherited by the self-registering versions of all specific callback listeners. More...
 
class  ILogger
 The interface for logging. More...
 
class  ILobbyListListener
 Listener for the event of receiving a list of lobbies. More...
 
class  ILobbyCreatedListener
 Listener for the event of creating a lobby. More...
 
class  ILobbyEnteredListener
 Listener for the event of entering a lobby. More...
 
class  ILobbyLeftListener
 Listener for the event of leaving a lobby. More...
 
class  ILobbyDataListener
 Listener for the event of receiving an updated version of lobby data. More...
 
class  ILobbyDataUpdateListener
 Listener for the event of updating lobby data. More...
 
class  ILobbyMemberDataUpdateListener
 Listener for the event of updating lobby member data. More...
 
class  ILobbyDataRetrieveListener
 Listener for the event of retrieving lobby data. More...
 
class  ILobbyMemberStateListener
 Listener for the event of a change of the state of a lobby member. More...
 
class  ILobbyOwnerChangeListener
 Listener for the event of changing the owner of a lobby. More...
 
class  ILobbyMessageListener
 Listener for the event of receiving a lobby message. More...
 
class  IMatchmaking
 The interface for managing game lobbies. More...
 
class  INetworkingListener
 Listener for the events related to packets that come to the client. More...
 
class  INatTypeDetectionListener
 Listener for the events related to NAT type detection. More...
 
class  INetworking
 The interface for communicating with other Galaxy Peers. More...
 
struct  InitOptions
 The group of options used for Init configuration. More...
 
class  IUserStatsAndAchievementsRetrieveListener
 Listener for the event of retrieving statistics and achievements of a specified user, possibly our own. More...
 
class  IStatsAndAchievementsStoreListener
 Listener for the event of storing own statistics and achievements. More...
 
class  IAchievementChangeListener
 Listener for the event of changing an achievement. More...
 
class  ILeaderboardsRetrieveListener
 Listener for the event of retrieving definitions of leaderboards. More...
 
class  ILeaderboardEntriesRetrieveListener
 Listener for the event of retrieving requested entries of a leaderboard. More...
 
class  ILeaderboardScoreUpdateListener
 Listener for the event of updating score in a leaderboard. More...
 
class  ILeaderboardRetrieveListener
 Listener for the event of retrieving definition of a leaderboard. More...
 
class  IUserTimePlayedRetrieveListener
 Listener for the event of retrieving user time played. More...
 
class  IStats
 The interface for managing statistics, achievements and leaderboards. More...
 
class  IFileShareListener
 Listener for the event of sharing a file. More...
 
class  ISharedFileDownloadListener
 Listener for the event of downloading a shared file. More...
 
class  IStorage
 The interface for managing of cloud storage files. More...
 
class  ITelemetryEventSendListener
 Listener for the event of sending a telemetry event. More...
 
class  ITelemetry
 The interface for handling telemetry. More...
 
class  IAuthListener
 Listener for the events related to user authentication. More...
 
class  IOtherSessionStartListener
 Listener for the events related to starting of other sessions. More...
 
class  IOperationalStateChangeListener
 Listener for the event of a change of the operational state. More...
 
class  IUserDataListener
 Listener for the events related to user data changes of current user only. More...
 
class  ISpecificUserDataListener
 Listener for the events related to user data changes. More...
 
class  IEncryptedAppTicketListener
 Listener for the event of retrieving a requested Encrypted App Ticket. More...
 
class  IAccessTokenListener
 Listener for the event of a change of current access token. More...
 
class  IUser
 The interface for handling the user account. More...
 
class  IOverlayVisibilityChangeListener
 Listener for the event of changing overlay visibility. More...
 
class  IOverlayInitializationStateChangeListener
 Listener for the event of changing overlay state. More...
 
class  INotificationListener
 Listener for the event of receiving a notification. More...
 
class  IGogServicesConnectionStateListener
 Listener for the event of GOG services connection change. More...
 
class  IUtils
 The interface for managing images. More...
 

Typedefs

typedef void *(* GalaxyMalloc) (uint32_t size, const char *typeName)
 Allocate function. More...
 
typedef void *(* GalaxyRealloc) (void *ptr, uint32_t newSize, const char *typeName)
 Reallocate function. More...
 
typedef void(* GalaxyFree) (void *ptr)
 Free function. More...
 
typedef void * ThreadEntryParam
 The parameter for the thread entry point.
 
typedef void(* ThreadEntryFunction) (ThreadEntryParam)
 The entry point function which shall be started in a new thread.
 
typedef uint64_t ProductID
 The ID of the DLC.
 
typedef uint64_t ChatRoomID
 The ID of a chat room.
 
typedef uint64_t ChatMessageID
 Global ID of a chat message.
 
typedef SelfRegisteringListener< IChatRoomWithUserRetrieveListenerGlobalChatRoomWithUserRetrieveListener
 Globally self-registering version of IChatRoomWithUserRetrieveListener.
 
typedef SelfRegisteringListener< IChatRoomMessageSendListenerGlobalChatRoomMessageSendListener
 Globally self-registering version of IChatRoomMessageSendListener.
 
typedef SelfRegisteringListener< IChatRoomMessagesListenerGlobalChatRoomMessagesListener
 Globally self-registering version of IChatRoomMessagesListener.
 
typedef SelfRegisteringListener< IChatRoomMessagesRetrieveListenerGlobalChatRoomMessagesRetrieveListener
 Globally self-registering version of IChatRoomMessagesRetrieveListener.
 
typedef uint64_t ConnectionID
 ID of a connection.
 
typedef SelfRegisteringListener< IConnectionOpenListenerGlobalConnectionOpenListener
 Globally self-registering version of IConnectionOpenListener.
 
typedef SelfRegisteringListener< IConnectionCloseListenerGlobalConnectionCloseListener
 Globally self-registering version of IConnectionCloseListener.
 
typedef SelfRegisteringListener< IConnectionDataListenerGlobalConnectionDataListener
 Globally self-registering version of IConnectionDataListener.
 
typedef uint32_t AvatarCriteria
 The bit sum of the AvatarType.
 
typedef SelfRegisteringListener< IPersonaDataChangedListenerGlobalPersonaDataChangedListener
 Globally self-registering version of IPersonaDataChangedListener.
 
typedef SelfRegisteringListener< IUserInformationRetrieveListenerGlobalUserInformationRetrieveListener
 Globally self-registering version of IUserInformationRetrieveListener.
 
typedef SelfRegisteringListener< IFriendListListenerGlobalFriendListListener
 Globally self-registering version of IFriendListListener.
 
typedef SelfRegisteringListener< IFriendInvitationSendListenerGlobalFriendInvitationSendListener
 Globally self-registering version of IFriendInvitationSendListener.
 
typedef SelfRegisteringListener< IFriendInvitationListRetrieveListenerGlobalFriendInvitationListRetrieveListener
 Globally self-registering version of IFriendInvitationListRetrieveListener.
 
typedef SelfRegisteringListener< ISentFriendInvitationListRetrieveListenerGlobalSentFriendInvitationListRetrieveListener
 Globally self-registering version of ISentFriendInvitationListRetrieveListener.
 
typedef SelfRegisteringListener< IFriendInvitationListenerGlobalFriendInvitationListener
 Globally self-registering version of IFriendInvitationListener.
 
typedef SelfRegisteringListener< IFriendInvitationRespondToListenerGlobalFriendInvitationRespondToListener
 Globally self-registering version of IFriendInvitationRespondToListener.
 
typedef SelfRegisteringListener< IFriendAddListenerGlobalFriendAddListener
 Globally self-registering version of IFriendAddListener.
 
typedef SelfRegisteringListener< IFriendDeleteListenerGlobalFriendDeleteListener
 Globally self-registering version of IFriendDeleteListener.
 
typedef SelfRegisteringListener< IRichPresenceChangeListenerGlobalRichPresenceChangeListener
 Globally self-registering version of IRichPresenceChangeListener.
 
typedef SelfRegisteringListener< IRichPresenceListenerGlobalRichPresenceListener
 Globally self-registering version of IRichPresenceListener.
 
typedef SelfRegisteringListener< IRichPresenceRetrieveListenerGlobalRichPresenceRetrieveListener
 Globally self-registering version of IRichPresenceRetrieveListener.
 
typedef SelfRegisteringListener< IGameJoinRequestedListenerGlobalGameJoinRequestedListener
 Globally self-registering version of IGameJoinRequestedListener.
 
typedef SelfRegisteringListener< IGameInvitationReceivedListenerGlobalGameInvitationReceivedListener
 Globally self-registering version of IGameInvitationReceivedListener.
 
typedef SelfRegisteringListener< ISendInvitationListenerGlobalSendInvitationListener
 Globally self-registering version of ISendInvitationListener.
 
typedef SelfRegisteringListener< IUserFindListenerGlobalUserFindListener
 Globally self-registering version of IUserFindListener.
 
typedef SelfRegisteringListener< ILobbyListListenerGlobalLobbyListListener
 Globally self-registering version of ILobbyListListener.
 
typedef SelfRegisteringListener< ILobbyCreatedListenerGlobalLobbyCreatedListener
 Globally self-registering version of ILobbyCreatedListener.
 
typedef SelfRegisteringListener< ILobbyCreatedListener, GameServerListenerRegistrar > GameServerGlobalLobbyCreatedListener
 Globally self-registering version of ILobbyCreatedListener for the Game Server.
 
typedef SelfRegisteringListener< ILobbyEnteredListenerGlobalLobbyEnteredListener
 Globally self-registering version of ILobbyEnteredListener.
 
typedef SelfRegisteringListener< ILobbyEnteredListener, GameServerListenerRegistrar > GameServerGlobalLobbyEnteredListener
 Globally self-registering version of ILobbyEnteredListener for the GameServer.
 
typedef SelfRegisteringListener< ILobbyLeftListenerGlobalLobbyLeftListener
 Globally self-registering version of ILobbyLeftListener.
 
typedef SelfRegisteringListener< ILobbyLeftListener, GameServerListenerRegistrar > GameServerGlobalLobbyLeftListener
 Globally self-registering version of ILobbyLeftListener for the GameServer.
 
typedef SelfRegisteringListener< ILobbyDataListenerGlobalLobbyDataListener
 Globally self-registering version of ILobbyDataListener.
 
typedef SelfRegisteringListener< ILobbyDataListener, GameServerListenerRegistrar > GameServerGlobalLobbyDataListener
 Globally self-registering version of ILobbyDataListener for the Game Server.
 
typedef SelfRegisteringListener< ILobbyDataRetrieveListenerGlobalLobbyDataRetrieveListener
 Globally self-registering version of ILobbyDataRetrieveListener.
 
typedef SelfRegisteringListener< ILobbyDataRetrieveListener, GameServerListenerRegistrar > GameServerGlobalLobbyDataRetrieveListener
 Globally self-registering version of ILobbyDataRetrieveListener for the Game Server.
 
typedef SelfRegisteringListener< ILobbyMemberStateListenerGlobalLobbyMemberStateListener
 Globally self-registering version of ILobbyMemberStateListener.
 
typedef SelfRegisteringListener< ILobbyMemberStateListener, GameServerListenerRegistrar > GameServerGlobalLobbyMemberStateListener
 Globally self-registering version of ILobbyMemberStateListener for the Game Server.
 
typedef SelfRegisteringListener< ILobbyOwnerChangeListenerGlobalLobbyOwnerChangeListener
 Globally self-registering version of ILobbyOwnerChangeListener.
 
typedef SelfRegisteringListener< ILobbyMessageListenerGlobalLobbyMessageListener
 Globally self-registering version of ILobbyMessageListener.
 
typedef SelfRegisteringListener< ILobbyMessageListener, GameServerListenerRegistrar > GameServerGlobalLobbyMessageListener
 Globally self-registering version of ILobbyMessageListener for the Game Server.
 
typedef SelfRegisteringListener< INetworkingListenerGlobalNetworkingListener
 Globally self-registering version of INetworkingListener.
 
typedef SelfRegisteringListener< INetworkingListener, GameServerListenerRegistrar > GameServerGlobalNetworkingListener
 Globally self-registering version of INetworkingListener for the GameServer.
 
typedef SelfRegisteringListener< INatTypeDetectionListenerGlobalNatTypeDetectionListener
 Globally self-registering version of INatTypeDetectionListener.
 
typedef SelfRegisteringListener< INatTypeDetectionListener, GameServerListenerRegistrar > GameServerGlobalNatTypeDetectionListener
 Globally self-registering version of INatTypeDetectionListener for the GameServer.
 
typedef SelfRegisteringListener< IUserStatsAndAchievementsRetrieveListenerGlobalUserStatsAndAchievementsRetrieveListener
 Globally self-registering version of IUserStatsAndAchievementsRetrieveListener.
 
typedef SelfRegisteringListener< IStatsAndAchievementsStoreListenerGlobalStatsAndAchievementsStoreListener
 Globally self-registering version of IStatsAndAchievementsStoreListener.
 
typedef SelfRegisteringListener< IAchievementChangeListenerGlobalAchievementChangeListener
 Globally self-registering version of IAchievementChangeListener.
 
typedef SelfRegisteringListener< ILeaderboardsRetrieveListenerGlobalLeaderboardsRetrieveListener
 Globally self-registering version of a ILeaderboardsRetrieveListener.
 
typedef SelfRegisteringListener< ILeaderboardEntriesRetrieveListenerGlobalLeaderboardEntriesRetrieveListener
 Globally self-registering version of a ILeaderboardEntriesRetrieveListener.
 
typedef SelfRegisteringListener< ILeaderboardScoreUpdateListenerGlobalLeaderboardScoreUpdateListener
 Globally self-registering version of a ILeaderboardScoreUpdateListener.
 
typedef SelfRegisteringListener< ILeaderboardRetrieveListenerGlobalLeaderboardRetrieveListener
 Globally self-registering version of a ILeaderboardRetrieveListener.
 
typedef SelfRegisteringListener< IUserTimePlayedRetrieveListenerGlobalUserTimePlayedRetrieveListener
 Globally self-registering version of a IUserTimePlayedRetrieveListener.
 
typedef uint64_t SharedFileID
 ID of a shared file.
 
typedef SelfRegisteringListener< IFileShareListenerGlobalFileShareListener
 Globally self-registering version of IFileShareListener.
 
typedef SelfRegisteringListener< ISharedFileDownloadListenerGlobalSharedFileDownloadListener
 Globally self-registering version of ISharedFileDownloadListener.
 
typedef SelfRegisteringListener< ITelemetryEventSendListenerGlobalTelemetryEventSendListener
 Globally self-registering version of ITelemetryEventSendListener.
 
typedef SelfRegisteringListener< ITelemetryEventSendListener, GameServerListenerRegistrar > GameServerGlobalTelemetryEventSendListener
 Globally self-registering version of ITelemetryEventSendListener for the Game Server.
 
typedef uint64_t SessionID
 The ID of the session.
 
typedef SelfRegisteringListener< IAuthListenerGlobalAuthListener
 Globally self-registering version of IAuthListener.
 
typedef SelfRegisteringListener< IAuthListener, GameServerListenerRegistrar > GameServerGlobalAuthListener
 Globally self-registering version of IAuthListener for the Game Server.
 
typedef SelfRegisteringListener< IOtherSessionStartListenerGlobalOtherSessionStartListener
 Globally self-registering version of IOtherSessionStartListener.
 
typedef SelfRegisteringListener< IOtherSessionStartListener, GameServerListenerRegistrar > GameServerGlobalOtherSessionStartListener
 Globally self-registering version of IOtherSessionStartListener for the Game Server.
 
typedef SelfRegisteringListener< IOperationalStateChangeListenerGlobalOperationalStateChangeListener
 Globally self-registering version of IOperationalStateChangeListener.
 
typedef SelfRegisteringListener< IOperationalStateChangeListener, GameServerListenerRegistrar > GameServerGlobalOperationalStateChangeListener
 Globally self-registering version of IOperationalStateChangeListener for the GameServer.
 
typedef SelfRegisteringListener< IUserDataListenerGlobalUserDataListener
 Globally self-registering version of IUserDataListener.
 
typedef SelfRegisteringListener< IUserDataListener, GameServerListenerRegistrar > GameServerGlobalUserDataListener
 Globally self-registering version of IUserDataListener for the GameServer.
 
typedef SelfRegisteringListener< ISpecificUserDataListenerGlobalSpecificUserDataListener
 Globally self-registering version of ISpecificUserDataListener.
 
typedef SelfRegisteringListener< ISpecificUserDataListener, GameServerListenerRegistrar > GameServerGlobalSpecificUserDataListener
 Globally self-registering version of ISpecificUserDataListener for the Game Server.
 
typedef SelfRegisteringListener< IEncryptedAppTicketListenerGlobalEncryptedAppTicketListener
 Globally self-registering version of IEncryptedAppTicketListener.
 
typedef SelfRegisteringListener< IEncryptedAppTicketListener, GameServerListenerRegistrar > GameServerGlobalEncryptedAppTicketListener
 Globally self-registering version of IEncryptedAppTicketListener for the Game Server.
 
typedef SelfRegisteringListener< IAccessTokenListenerGlobalAccessTokenListener
 Globally self-registering version of IAccessTokenListener.
 
typedef SelfRegisteringListener< IAccessTokenListener, GameServerListenerRegistrar > GameServerGlobalAccessTokenListener
 Globally self-registering version of IAccessTokenListener for the GameServer.
 
typedef uint64_t NotificationID
 The ID of the notification.
 
typedef SelfRegisteringListener< IOverlayVisibilityChangeListenerGlobalOverlayVisibilityChangeListener
 Globally self-registering version of IOverlayStateChangeListener.
 
typedef SelfRegisteringListener< IOverlayInitializationStateChangeListenerGlobalOverlayInitializationStateChangeListener
 Globally self-registering version of IOverlayInitializationStateChangeListener.
 
typedef SelfRegisteringListener< INotificationListenerGlobalNotificationListener
 Globally self-registering version of INotificationListener.
 
typedef SelfRegisteringListener< IGogServicesConnectionStateListenerGlobalGogServicesConnectionStateListener
 Globally self-registering version of IGogServicesConnectionStateListener.
 
typedef SelfRegisteringListener< IGogServicesConnectionStateListener, GameServerListenerRegistrar > GameServerGlobalGogServicesConnectionStateListener
 Globally self-registering version of IGogServicesConnectionStateListener for the Game Server.
 

Enumerations

enum  ChatMessageType { CHAT_MESSAGE_TYPE_UNKNOWN , CHAT_MESSAGE_TYPE_CHAT_MESSAGE , CHAT_MESSAGE_TYPE_GAME_INVITATION }
 The type of a chat message. More...
 
enum  AvatarType { AVATAR_TYPE_NONE = 0x0000 , AVATAR_TYPE_SMALL = 0x0001 , AVATAR_TYPE_MEDIUM = 0x0002 , AVATAR_TYPE_LARGE = 0x0004 }
 The type of avatar. More...
 
enum  PersonaState { PERSONA_STATE_OFFLINE , PERSONA_STATE_ONLINE }
 The state of the user. More...
 
enum  ListenerType {
  LISTENER_TYPE_BEGIN , LOBBY_LIST = LISTENER_TYPE_BEGIN , LOBBY_CREATED , LOBBY_ENTERED ,
  LOBBY_LEFT , LOBBY_DATA , LOBBY_MEMBER_STATE , LOBBY_OWNER_CHANGE ,
  AUTH , LOBBY_MESSAGE , NETWORKING , USER_DATA ,
  USER_STATS_AND_ACHIEVEMENTS_RETRIEVE , STATS_AND_ACHIEVEMENTS_STORE , ACHIEVEMENT_CHANGE , LEADERBOARDS_RETRIEVE ,
  LEADERBOARD_ENTRIES_RETRIEVE , LEADERBOARD_SCORE_UPDATE_LISTENER , PERSONA_DATA_CHANGED , RICH_PRESENCE_CHANGE_LISTENER ,
  GAME_JOIN_REQUESTED_LISTENER , OPERATIONAL_STATE_CHANGE , FRIEND_LIST_RETRIEVE , ENCRYPTED_APP_TICKET_RETRIEVE ,
  ACCESS_TOKEN_CHANGE , LEADERBOARD_RETRIEVE , SPECIFIC_USER_DATA , INVITATION_SEND ,
  RICH_PRESENCE_LISTENER , GAME_INVITATION_RECEIVED_LISTENER , NOTIFICATION_LISTENER , LOBBY_DATA_RETRIEVE ,
  USER_TIME_PLAYED_RETRIEVE , OTHER_SESSION_START , FILE_SHARE , SHARED_FILE_DOWNLOAD ,
  CUSTOM_NETWORKING_CONNECTION_OPEN , CUSTOM_NETWORKING_CONNECTION_CLOSE , CUSTOM_NETWORKING_CONNECTION_DATA , OVERLAY_INITIALIZATION_STATE_CHANGE ,
  OVERLAY_VISIBILITY_CHANGE , CHAT_ROOM_WITH_USER_RETRIEVE_LISTENER , CHAT_ROOM_MESSAGE_SEND_LISTENER , CHAT_ROOM_MESSAGES_LISTENER ,
  FRIEND_INVITATION_SEND_LISTENER , FRIEND_INVITATION_LIST_RETRIEVE_LISTENER , FRIEND_INVITATION_LISTENER , FRIEND_INVITATION_RESPOND_TO_LISTENER ,
  FRIEND_ADD_LISTENER , FRIEND_DELETE_LISTENER , CHAT_ROOM_MESSAGES_RETRIEVE_LISTENER , USER_FIND_LISTENER ,
  NAT_TYPE_DETECTION , SENT_FRIEND_INVITATION_LIST_RETRIEVE_LISTENER , LOBBY_DATA_UPDATE_LISTENER , LOBBY_MEMBER_DATA_UPDATE_LISTENER ,
  USER_INFORMATION_RETRIEVE_LISTENER , RICH_PRESENCE_RETRIEVE_LISTENER , GOG_SERVICES_CONNECTION_STATE_LISTENER , TELEMETRY_EVENT_SEND_LISTENER ,
  LISTENER_TYPE_END
}
 Listener type. More...
 
enum  LobbyType { LOBBY_TYPE_PRIVATE , LOBBY_TYPE_FRIENDS_ONLY , LOBBY_TYPE_PUBLIC , LOBBY_TYPE_INVISIBLE_TO_FRIENDS }
 Lobby type. More...
 
enum  LobbyTopologyType {
  DEPRECATED_LOBBY_TOPOLOGY_TYPE_FCM_HOST_MIGRATION , LOBBY_TOPOLOGY_TYPE_FCM , LOBBY_TOPOLOGY_TYPE_STAR , LOBBY_TOPOLOGY_TYPE_CONNECTIONLESS ,
  LOBBY_TOPOLOGY_TYPE_FCM_OWNERSHIP_TRANSITION
}
 Lobby topology type. More...
 
enum  LobbyMemberStateChange {
  LOBBY_MEMBER_STATE_CHANGED_ENTERED = 0x0001 , LOBBY_MEMBER_STATE_CHANGED_LEFT = 0x0002 , LOBBY_MEMBER_STATE_CHANGED_DISCONNECTED = 0x0004 , LOBBY_MEMBER_STATE_CHANGED_KICKED = 0x0008 ,
  LOBBY_MEMBER_STATE_CHANGED_BANNED = 0x0010
}
 Change of the state of a lobby member. More...
 
enum  LobbyComparisonType {
  LOBBY_COMPARISON_TYPE_EQUAL , LOBBY_COMPARISON_TYPE_NOT_EQUAL , LOBBY_COMPARISON_TYPE_GREATER , LOBBY_COMPARISON_TYPE_GREATER_OR_EQUAL ,
  LOBBY_COMPARISON_TYPE_LOWER , LOBBY_COMPARISON_TYPE_LOWER_OR_EQUAL
}
 Comparison type. More...
 
enum  LobbyCreateResult { LOBBY_CREATE_RESULT_SUCCESS , LOBBY_CREATE_RESULT_ERROR , LOBBY_CREATE_RESULT_CONNECTION_FAILURE }
 Lobby creating result. More...
 
enum  LobbyEnterResult {
  LOBBY_ENTER_RESULT_SUCCESS , LOBBY_ENTER_RESULT_LOBBY_DOES_NOT_EXIST , LOBBY_ENTER_RESULT_LOBBY_IS_FULL , LOBBY_ENTER_RESULT_ERROR ,
  LOBBY_ENTER_RESULT_CONNECTION_FAILURE
}
 Lobby entering result. More...
 
enum  LobbyListResult { LOBBY_LIST_RESULT_SUCCESS , LOBBY_LIST_RESULT_ERROR , LOBBY_LIST_RESULT_CONNECTION_FAILURE }
 Lobby listing result. More...
 
enum  NatType {
  NAT_TYPE_NONE , NAT_TYPE_FULL_CONE , NAT_TYPE_ADDRESS_RESTRICTED , NAT_TYPE_PORT_RESTRICTED ,
  NAT_TYPE_SYMMETRIC , NAT_TYPE_UNKNOWN
}
 NAT types. More...
 
enum  P2PSendType { P2P_SEND_UNRELIABLE , P2P_SEND_RELIABLE , P2P_SEND_UNRELIABLE_IMMEDIATE , P2P_SEND_RELIABLE_IMMEDIATE }
 Send type used when calling INetworking::SendP2PPacket() in order to specify desired reliability of the data transfer for each packet that is being sent. More...
 
enum  ConnectionType { CONNECTION_TYPE_NONE , CONNECTION_TYPE_DIRECT , CONNECTION_TYPE_PROXY }
 Connection types. More...
 
enum  LeaderboardSortMethod { LEADERBOARD_SORT_METHOD_NONE , LEADERBOARD_SORT_METHOD_ASCENDING , LEADERBOARD_SORT_METHOD_DESCENDING }
 The sort order of a leaderboard. More...
 
enum  LeaderboardDisplayType { LEADERBOARD_DISPLAY_TYPE_NONE , LEADERBOARD_DISPLAY_TYPE_NUMBER , LEADERBOARD_DISPLAY_TYPE_TIME_SECONDS , LEADERBOARD_DISPLAY_TYPE_TIME_MILLISECONDS }
 The display type of a leaderboard. More...
 
enum  OverlayState {
  OVERLAY_STATE_UNDEFINED , OVERLAY_STATE_NOT_SUPPORTED , OVERLAY_STATE_DISABLED , OVERLAY_STATE_FAILED_TO_INITIALIZE ,
  OVERLAY_STATE_INITIALIZED
}
 State of the overlay. More...
 
enum  GogServicesConnectionState { GOG_SERVICES_CONNECTION_STATE_UNDEFINED , GOG_SERVICES_CONNECTION_STATE_CONNECTED , GOG_SERVICES_CONNECTION_STATE_DISCONNECTED , GOG_SERVICES_CONNECTION_STATE_AUTH_LOST }
 State of connection to the GOG services. More...
 

Functions

GALAXY_DLL_EXPORT const IError *GALAXY_CALLTYPE GetError ()
 Retrieves error connected with the last API call on the local thread. More...
 

Detailed Description

Typedef Documentation

◆ GalaxyFree

typedef void(* GalaxyFree) (void *ptr)

Free function.

Parameters
[in]ptrPointer to memory block requested to be freed.

◆ GalaxyMalloc

typedef void*(* GalaxyMalloc) (uint32_t size, const char *typeName)

Allocate function.

Parameters
[in]sizeRequested size of allocation.
[in]typeNameString which identifies the type of allocation.
Returns
Pointer to memory block or NULL if it goes out of memory.

◆ GalaxyRealloc

typedef void*(* GalaxyRealloc) (void *ptr, uint32_t newSize, const char *typeName)

Reallocate function.

Parameters
[in]ptrPointer to the memory block to be reallocated.
[in]newSizeNew, requested size of allocation.
[in]typeNameString which identifies the type of allocation.
Returns
Pointer to memory block or NULL if it goes out of memory.

Enumeration Type Documentation

◆ AvatarType

enum AvatarType

The type of avatar.

Enumerator
AVATAR_TYPE_NONE 

No avatar type specified.

AVATAR_TYPE_SMALL 

Avatar resolution size: 32x32.

AVATAR_TYPE_MEDIUM 

Avatar resolution size: 64x64.

AVATAR_TYPE_LARGE 

Avatar resolution size: 184x184.

◆ ChatMessageType

The type of a chat message.

Enumerator
CHAT_MESSAGE_TYPE_UNKNOWN 

Unknown message type.

CHAT_MESSAGE_TYPE_CHAT_MESSAGE 

Chat message.

CHAT_MESSAGE_TYPE_GAME_INVITATION 

Game invitation.

◆ ConnectionType

Connection types.

Enumerator
CONNECTION_TYPE_NONE 

User is connected only with server.

CONNECTION_TYPE_DIRECT 

User is connected directly.

CONNECTION_TYPE_PROXY 

User is connected through a proxy.

◆ GogServicesConnectionState

State of connection to the GOG services.

Enumerator
GOG_SERVICES_CONNECTION_STATE_UNDEFINED 

Connection state is undefined.

GOG_SERVICES_CONNECTION_STATE_CONNECTED 

Connection to the GOG services has been established.

GOG_SERVICES_CONNECTION_STATE_DISCONNECTED 

Connection to the GOG services has been lost.

GOG_SERVICES_CONNECTION_STATE_AUTH_LOST 

Connection to the GOG services has been lost due to lose of peer authentication.

◆ LeaderboardDisplayType

The display type of a leaderboard.

Enumerator
LEADERBOARD_DISPLAY_TYPE_NONE 

Not display type specified.

LEADERBOARD_DISPLAY_TYPE_NUMBER 

Simple numerical score.

LEADERBOARD_DISPLAY_TYPE_TIME_SECONDS 

The score represents time, in seconds.

LEADERBOARD_DISPLAY_TYPE_TIME_MILLISECONDS 

The score represents time, in milliseconds.

◆ LeaderboardSortMethod

The sort order of a leaderboard.

Enumerator
LEADERBOARD_SORT_METHOD_NONE 

No sorting method specified.

LEADERBOARD_SORT_METHOD_ASCENDING 

Top score is lowest number.

LEADERBOARD_SORT_METHOD_DESCENDING 

Top score is highest number.

◆ ListenerType

Listener type.

Used when registering or unregistering instances of listeners.

Specific listener interfaces are type-aware, i.e. they provide a convenience method that returns their type.

Enumerator
LISTENER_TYPE_BEGIN 

Used for iterating over listener types.

LOBBY_LIST 

Used by ILobbyListListener.

LOBBY_CREATED 

Used by ILobbyCreatedListener.

LOBBY_ENTERED 

Used by ILobbyEnteredListener.

LOBBY_LEFT 

Used by ILobbyLeftListener.

LOBBY_DATA 

Used by ILobbyDataListener.

LOBBY_MEMBER_STATE 

Used by ILobbyMemberStateListener.

LOBBY_OWNER_CHANGE 

Used by ILobbyOwnerChangeListener.

AUTH 

Used by IAuthListener.

LOBBY_MESSAGE 

Used by ILobbyMessageListener.

NETWORKING 

Used by INetworkingListener.

USER_DATA 

Used by IUserDataListener.

USER_STATS_AND_ACHIEVEMENTS_RETRIEVE 

Used by IUserStatsAndAchievementsRetrieveListener.

STATS_AND_ACHIEVEMENTS_STORE 

Used by IStatsAndAchievementsStoreListener.

ACHIEVEMENT_CHANGE 

Used by IAchievementChangeListener.

LEADERBOARDS_RETRIEVE 

Used by ILeaderboardsRetrieveListener.

LEADERBOARD_ENTRIES_RETRIEVE 

Used by ILeaderboardEntriesRetrieveListener.

LEADERBOARD_SCORE_UPDATE_LISTENER 

Used by ILeaderboardScoreUpdateListener.

PERSONA_DATA_CHANGED 

Used by IPersonaDataChangedListener.

RICH_PRESENCE_CHANGE_LISTENER 

Used by IRichPresenceChangeListener.

GAME_JOIN_REQUESTED_LISTENER 

Used by IGameJoinRequested.

OPERATIONAL_STATE_CHANGE 

Used by IOperationalStateChangeListener.

FRIEND_LIST_RETRIEVE 

Used by IFriendListListener.

ENCRYPTED_APP_TICKET_RETRIEVE 

Used by IEncryptedAppTicketListener.

ACCESS_TOKEN_CHANGE 

Used by IAccessTokenListener.

LEADERBOARD_RETRIEVE 

Used by ILeaderboardRetrieveListener.

SPECIFIC_USER_DATA 

Used by ISpecificUserDataListener.

INVITATION_SEND 

Used by ISendInvitationListener.

RICH_PRESENCE_LISTENER 

Used by IRichPresenceListener.

GAME_INVITATION_RECEIVED_LISTENER 

Used by IGameInvitationReceivedListener.

NOTIFICATION_LISTENER 

Used by INotificationListener.

LOBBY_DATA_RETRIEVE 

Used by ILobbyDataRetrieveListener.

USER_TIME_PLAYED_RETRIEVE 

Used by IUserTimePlayedRetrieveListener.

OTHER_SESSION_START 

Used by IOtherSessionStartListener.

FILE_SHARE 

Used by IFileShareListener.

SHARED_FILE_DOWNLOAD 

Used by ISharedFileDownloadListener.

CUSTOM_NETWORKING_CONNECTION_OPEN 

Used by IConnectionOpenListener.

CUSTOM_NETWORKING_CONNECTION_CLOSE 

Used by IConnectionCloseListener.

CUSTOM_NETWORKING_CONNECTION_DATA 

Used by IConnectionDataListener.

OVERLAY_INITIALIZATION_STATE_CHANGE 

Used by IOverlayInitializationStateChangeListener.

OVERLAY_VISIBILITY_CHANGE 

Used by IOverlayVisibilityChangeListener.

CHAT_ROOM_WITH_USER_RETRIEVE_LISTENER 

Used by IChatRoomWithUserRetrieveListener.

CHAT_ROOM_MESSAGE_SEND_LISTENER 

Used by IChatRoomMessageSendListener.

CHAT_ROOM_MESSAGES_LISTENER 

Used by IChatRoomMessagesListener.

FRIEND_INVITATION_SEND_LISTENER 

Used by IFriendInvitationSendListener.

FRIEND_INVITATION_LIST_RETRIEVE_LISTENER 

Used by IFriendInvitationListRetrieveListener.

FRIEND_INVITATION_LISTENER 

Used by IFriendInvitationListener.

FRIEND_INVITATION_RESPOND_TO_LISTENER 

Used by IFriendInvitationRespondToListener.

FRIEND_ADD_LISTENER 

Used by IFriendAddListener.

FRIEND_DELETE_LISTENER 

Used by IFriendDeleteListener.

CHAT_ROOM_MESSAGES_RETRIEVE_LISTENER 

Used by IChatRoomMessagesRetrieveListener.

USER_FIND_LISTENER 

Used by IUserFindListener.

NAT_TYPE_DETECTION 

Used by INatTypeDetectionListener.

SENT_FRIEND_INVITATION_LIST_RETRIEVE_LISTENER 

Used by ISentFriendInvitationListRetrieveListener.

LOBBY_MEMBER_DATA_UPDATE_LISTENER 

< Used by ILobbyDataUpdateListener.

USER_INFORMATION_RETRIEVE_LISTENER 

< Used by ILobbyDataUpdateListener.

Used by IUserInformationRetrieveListener.

RICH_PRESENCE_RETRIEVE_LISTENER 

Used by IRichPresenceRetrieveListener.

GOG_SERVICES_CONNECTION_STATE_LISTENER 

Used by IGogServicesConnectionStateListener.

TELEMETRY_EVENT_SEND_LISTENER 

Used by ITelemetryEventSendListener.

LISTENER_TYPE_END 

Used for iterating over listener types.

◆ LobbyComparisonType

Comparison type.

Used for specifying filters that are supposed to be invoked to validate lobby properties when requesting for a list of matching lobbies.

Enumerator
LOBBY_COMPARISON_TYPE_EQUAL 

The lobby should have a property of a value that is equal to the one specified.

LOBBY_COMPARISON_TYPE_NOT_EQUAL 

The lobby should have a property of a value that is not equal to the one specified.

LOBBY_COMPARISON_TYPE_GREATER 

The lobby should have a property of a value that is greater than the one specified.

LOBBY_COMPARISON_TYPE_GREATER_OR_EQUAL 

The lobby should have a property of a value that is greater than or equal to the one specified.

LOBBY_COMPARISON_TYPE_LOWER 

The lobby should have a property of a value that is lower than the one specified.

LOBBY_COMPARISON_TYPE_LOWER_OR_EQUAL 

The lobby should have a property of a value that is lower than or equal to the one specified.

◆ LobbyCreateResult

Lobby creating result.

Enumerator
LOBBY_CREATE_RESULT_SUCCESS 

Lobby was created.

LOBBY_CREATE_RESULT_ERROR 

Unexpected error.

LOBBY_CREATE_RESULT_CONNECTION_FAILURE 

Unable to communicate with backend services.

◆ LobbyEnterResult

Lobby entering result.

Enumerator
LOBBY_ENTER_RESULT_SUCCESS 

The user has entered the lobby.

LOBBY_ENTER_RESULT_LOBBY_DOES_NOT_EXIST 

Specified lobby does not exist.

LOBBY_ENTER_RESULT_LOBBY_IS_FULL 

Specified lobby is full.

LOBBY_ENTER_RESULT_ERROR 

Unexpected error.

LOBBY_ENTER_RESULT_CONNECTION_FAILURE 

Unable to communicate with backend services.

◆ LobbyListResult

Lobby listing result.

Enumerator
LOBBY_LIST_RESULT_SUCCESS 

The list of lobbies retrieved successfully.

LOBBY_LIST_RESULT_ERROR 

Unexpected error.

LOBBY_LIST_RESULT_CONNECTION_FAILURE 

Unable to communicate with backend services.

◆ LobbyMemberStateChange

Change of the state of a lobby member.

Used in notifications.

Enumerator
LOBBY_MEMBER_STATE_CHANGED_ENTERED 

The user joined the lobby.

LOBBY_MEMBER_STATE_CHANGED_LEFT 

The user left the lobby having announced it first.

LOBBY_MEMBER_STATE_CHANGED_DISCONNECTED 

The user disconnected without leaving the lobby first.

LOBBY_MEMBER_STATE_CHANGED_KICKED 

User was kicked from the lobby.

LOBBY_MEMBER_STATE_CHANGED_BANNED 

User was kicked and banned from the lobby.

◆ LobbyTopologyType

Lobby topology type.

Used for specifying topology of user connections in lobby.

Enumerator
DEPRECATED_LOBBY_TOPOLOGY_TYPE_FCM_HOST_MIGRATION 

All users are connected with each other. Disconnection of lobby owner results in choosing a new one. Deprecated: use LOBBY_TOPOLOGY_TYPE_FCM_OWNERSHIP_TRANSITION instead.

LOBBY_TOPOLOGY_TYPE_FCM 

All users are connected with each other. Disconnection of lobby owner results in closing the lobby.

LOBBY_TOPOLOGY_TYPE_STAR 

All users are connected with lobby owner. Disconnection of lobby owner results in closing the lobby.

LOBBY_TOPOLOGY_TYPE_CONNECTIONLESS 

All users are connected only with server. Disconnection of lobby owner results in choosing a new one. Forbidden for the Game Server.

LOBBY_TOPOLOGY_TYPE_FCM_OWNERSHIP_TRANSITION 

All users are connected with each other. Disconnection of lobby owner results in choosing a new one. Forbidden for the Game Server.

◆ LobbyType

enum LobbyType

Lobby type.

Used for specifying visibility of a lobby and protecting it.

Enumerator
LOBBY_TYPE_PRIVATE 

Only invited users are able to join the lobby.

LOBBY_TYPE_FRIENDS_ONLY 

Visible only to friends or invitees, but not in lobby list. Forbidden for the Game Server.

LOBBY_TYPE_PUBLIC 

Visible for friends and in lobby list.

LOBBY_TYPE_INVISIBLE_TO_FRIENDS 

Returned by search, but not visible to friends. Forbidden for the Game Server.

◆ NatType

enum NatType

NAT types.

Enumerator
NAT_TYPE_NONE 

There is no NAT at all.

NAT_TYPE_FULL_CONE 

Accepts any datagrams to a port that has been previously used.

NAT_TYPE_ADDRESS_RESTRICTED 

Accepts datagrams to a port if the datagram source IP address belongs to a system that has been sent to.

NAT_TYPE_PORT_RESTRICTED 

Accepts datagrams to a port if the datagram source IP address and port belongs a system that has been sent to.

NAT_TYPE_SYMMETRIC 

A different port is chosen for every remote destination.

NAT_TYPE_UNKNOWN 

NAT type has not been determined.

◆ OverlayState

State of the overlay.

Enumerator
OVERLAY_STATE_UNDEFINED 

Overlay state is undefined.

OVERLAY_STATE_NOT_SUPPORTED 

Overlay is not supported.

OVERLAY_STATE_DISABLED 

Overlay is disabled by the user in the Galaxy Client.

OVERLAY_STATE_FAILED_TO_INITIALIZE 

Galaxy Client failed to initialize the overlay or inject it into the game.

OVERLAY_STATE_INITIALIZED 

Overlay has been successfully injected into the game.

◆ P2PSendType

Send type used when calling INetworking::SendP2PPacket() in order to specify desired reliability of the data transfer for each packet that is being sent.

Enumerator
P2P_SEND_UNRELIABLE 

UDP-like packet transfer. The packet will be sent during the next call to ProcessData().

P2P_SEND_RELIABLE 

TCP-like packet transfer. The packet will be sent during the next call to ProcessData().

P2P_SEND_UNRELIABLE_IMMEDIATE 

UDP-like packet transfer. The packet will be sent instantly.

P2P_SEND_RELIABLE_IMMEDIATE 

TCP-like packet transfer. The packet will be sent instantly.

◆ PersonaState

The state of the user.

Enumerator
PERSONA_STATE_OFFLINE 

User is not currently logged on.

PERSONA_STATE_ONLINE 

User is logged on.

Function Documentation

◆ GetError()

GALAXY_DLL_EXPORT const IError* GALAXY_CALLTYPE galaxy::api::GetError ( )

Retrieves error connected with the last API call on the local thread.

Returns
Either the last API call error or NULL if there was no error.