CClient.h

Go to the documentation of this file.

// Copyright. 2019 - 2024 PSBD. All rights reserved.
 
#pragma once
 
#include "Capsule/CDefinesPrivate.h"
#include "Capsule/CError.h"
#include "Capsule/CString.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum clCDisconnectReason {
    clC_DR_UserRequested,
    clC_DR_Destruction,
    clC_DR_FatalError
} clCDisconnectReason;
 
typedef enum clCConnectionState {
    clC_CS_Disconnected,
    clC_CS_Connecting,
    clC_CS_Connected,
    clC_CS_Disconnecting
} clCConnectionState;
 
CLC_CLASS_WN(ClientPrivate, clCClient);
 
CLC_STRUCT(clCClientDelegate);
typedef void (*clCClientHandler)(clCClient);
CL_DLL void clCClientDelegate_Set(clCClientDelegate delegate,
                                  clCClientHandler callback) NOEXCEPT;
CLC_STRUCT(clCClientDelegateDisconnectReason);
typedef void (*clCClientHandlerDisconnectReason)(clCClient,
                                                 clCDisconnectReason);
CL_DLL void clCClientDelegateDisconnectReason_Set(
    clCClientDelegateDisconnectReason delegate,
    clCClientHandlerDisconnectReason callback) NOEXCEPT;
CLC_STRUCT(clCClientDelegateError);
typedef void (*clCClientHandlerError)(clCClient, clCError);
CL_DLL void clCClientDelegateError_Set(clCClientDelegateError delegate,
                                       clCClientHandlerError callback) NOEXCEPT;
 
CL_DLL clCString clCClient_GetVersionString() NOEXCEPT;
 
CL_DLL void clCClient_SetAppVersion(clCClient client, const char* version);
 
CL_DLL clCClient clCClient_Create() NOEXCEPT;
CL_DLL clCClient clCClient_CreateWithName(const char* clientName) NOEXCEPT;
CL_DLL clCClient clCClient_CreateWithDataDirectory(const char* dataDir) NOEXCEPT;
CL_DLL clCClient clCClient_CreateWithDataDirectoryAndName(const char* dataDir,
                                                          const char* clientName) NOEXCEPT;
CL_DLL void clCClient_Destroy(clCClient client) NOEXCEPT;
CL_DLL void clCClient_Connect(clCClient client, const char* address) NOEXCEPT;
CL_DLL void clCClient_ConnectWithAccessToken(clCClient client,
                                             const char* address,
                                             const char* accessToken) NOEXCEPT;
CL_DLL void clCClient_ConnectWithAccessTokenAndPlatformAddress(clCClient client,
                                                               const char* address,
                                                               const char* accessToken,
                                                               const char* platformAddress) NOEXCEPT;
 
CL_DLL clCClientDelegate
clCClient_GetOnRefreshAccessTokenRequestedEvent(clCClient client) NOEXCEPT;
CL_DLL void clCClient_RefreshToken(clCClient client, const char* accessToken) NOEXCEPT;
CL_DLL uint64_t clCClient_GetTime() NOEXCEPT;
CL_DLL uint64_t clCClient_GetTimeMicro() NOEXCEPT;
CL_DLL void clCClient_Disconnect(clCClient client) NOEXCEPT;
CL_DLL bool clCClient_IsConnected(clCClient client) NOEXCEPT;
CL_DLL bool clCClient_IsConnecting(clCClient client) NOEXCEPT;
 
CL_DLL clCString clCClient_GetCapsuleVersion(clCClient client) NOEXCEPT;
CL_DLL clCString clCClient_GetClientName(clCClient client) NOEXCEPT;
CL_DLL clCString clCClient_GetDataDirectory(clCClient client) NOEXCEPT;
CL_DLL void clCClient_Update(clCClient client) NOEXCEPT;
 
CL_DLL clCClientDelegate clCClient_GetOnConnectedEvent(clCClient client) NOEXCEPT;
CL_DLL clCClientDelegateDisconnectReason
clCClient_GetOnDisconnectedEvent(clCClient client) NOEXCEPT;
CL_DLL clCClientDelegateError clCClient_GetOnErrorEvent(clCClient client) NOEXCEPT;
 
#ifdef __cplusplus
}
#endif