Ark Server API (ASE) - Wiki
Loading...
Searching...
No Matches
Foundation.h
Go to the documentation of this file.
1//
2// Foundation.h
3//
4// Library: Foundation
5// Package: Core
6// Module: Foundation
7//
8// Basic definitions for the POCO Foundation library.
9// This file must be the first file included by every other Foundation
10// header file.
11//
12// Copyright (c) 2004-2010, Applied Informatics Software Engineering GmbH.
13// and Contributors.
14//
15// SPDX-License-Identifier: BSL-1.0
16//
17
18
19#ifndef Foundation_Foundation_INCLUDED
20#define Foundation_Foundation_INCLUDED
21
22
23//
24// Include library configuration
25//
26#include "Poco/Config.h"
27
28
29//
30// Ensure that POCO_DLL is default unless POCO_STATIC is defined
31//
32#if defined(_WIN32) && defined(_DLL)
33 #if !defined(POCO_DLL) && !defined(POCO_STATIC)
34 #define POCO_DLL
35 #endif
36#endif
37
38
39//
40// The following block is the standard way of creating macros which make exporting
41// from a DLL simpler. All files within this DLL are compiled with the Foundation_EXPORTS
42// symbol defined on the command line. this symbol should not be defined on any project
43// that uses this DLL. This way any other project whose source files include this file see
44// Foundation_API functions as being imported from a DLL, wheras this DLL sees symbols
45// defined with this macro as being exported.
46//
47#if (defined(_WIN32) || defined(_WIN32_WCE)) && defined(POCO_DLL)
48 #if defined(Foundation_EXPORTS)
49 #define Foundation_API __declspec(dllexport)
50 #else
51 #define Foundation_API __declspec(dllimport)
52 #endif
53#endif
54
55
56#if !defined(Foundation_API)
57 #if !defined(POCO_NO_GCC_API_ATTRIBUTE) && defined (__GNUC__) && (__GNUC__ >= 4)
58 #define Foundation_API __attribute__ ((visibility ("default")))
59 #else
60 #define Foundation_API
61 #endif
62#endif
63
64
65//
66// Automatically link Foundation library.
67//
68#if defined(_MSC_VER)
69 #if defined(POCO_DLL)
70 #if defined(_DEBUG)
71 #define POCO_LIB_SUFFIX "d.lib"
72 #else
73 #define POCO_LIB_SUFFIX ".lib"
74 #endif
75 #elif defined(_DLL)
76 #if defined(_DEBUG)
77 #define POCO_LIB_SUFFIX "mdd.lib"
78 #else
79 #define POCO_LIB_SUFFIX "md.lib"
80 #endif
81 #else
82 #if defined(_DEBUG)
83 #define POCO_LIB_SUFFIX "mtd.lib"
84 #else
85 #define POCO_LIB_SUFFIX "mt.lib"
86 #endif
87 #endif
88
89 #if !defined(POCO_NO_AUTOMATIC_LIBS) && !defined(Foundation_EXPORTS)
90 #pragma comment(lib, "PocoFoundation" POCO_LIB_SUFFIX)
91 #endif
92#endif
93
94
95//
96// Include platform-specific definitions
97//
98#include "Poco/Platform.h"
99#if defined(_WIN32)
100 #include "Poco/Platform_WIN32.h"
101#elif defined(POCO_VXWORKS)
102 #include "Poco/Platform_VX.h"
103#elif defined(POCO_OS_FAMILY_UNIX)
104 #include "Poco/Platform_POSIX.h"
105#endif
106
107
108//
109// Include alignment settings early
110//
111#include "Poco/Alignment.h"
112
113//
114// Cleanup inconsistencies
115//
116#ifdef POCO_OS_FAMILY_WINDOWS
117 #if defined(POCO_NO_WSTRING)
118 #error POCO_NO_WSTRING is not supported on Windows.
119 #endif
120#endif
121
122
123//
124// POCO_JOIN
125//
126// The following piece of macro magic joins the two
127// arguments together, even when one of the arguments is
128// itself a macro (see 16.3.1 in C++ standard). The key
129// is that macro expansion of macro arguments does not
130// occur in POCO_DO_JOIN2 but does in POCO_DO_JOIN.
131//
132#define POCO_JOIN(X, Y) POCO_DO_JOIN(X, Y)
133#define POCO_DO_JOIN(X, Y) POCO_DO_JOIN2(X, Y)
134#define POCO_DO_JOIN2(X, Y) X##Y
135
136
137//
138// POCO_DEPRECATED
139//
140// A macro expanding to a compiler-specific clause to
141// mark a class or function as deprecated.
142//
143#if defined(POCO_NO_DEPRECATED)
144#define POCO_DEPRECATED
145#elif defined(_GNUC_)
146#define POCO_DEPRECATED __attribute__((deprecated))
147#elif defined(__clang__)
148#define POCO_DEPRECATED __attribute__((deprecated))
149#elif defined(_MSC_VER)
150#define POCO_DEPRECATED __declspec(deprecated)
151#else
152#define POCO_DEPRECATED
153#endif
154
155
156//
157// Pull in basic definitions
158//
159#include "Poco/Bugcheck.h"
160#include "Poco/Types.h"
161#include <string>
162
163
164#endif // Foundation_Foundation_INCLUDED
#define ARK_API
Definition Base.h:9
#define POCO_DO_JOIN2(X, Y)
Definition Foundation.h:134
#define POCO_DO_JOIN(X, Y)
Definition Foundation.h:133
#define Net_API
Definition Net.h:47
#define NetSSL_API
Definition NetSSL.h:48
#define POCO_OS_ANDROID
Definition Platform.h:41
#define POCO_OS_QNX
Definition Platform.h:37
#define POCO_OS_LINUX
Definition Platform.h:31
#define POCO_OS_SOLARIS
Definition Platform.h:36
virtual std::unique_ptr< ArkApi::ICommands > & GetCommands()=0
std::mutex RequestMutex_
Definition Requests.cpp:47
void WriteRequest(std::function< void(bool, std::string)> callback, bool success, std::string result)
Definition Requests.cpp:73
std::string GetResponse(Poco::Net::HTTPClientSession *session, Poco::Net::HTTPResponse &response)
Definition Requests.cpp:107
Poco::Net::HTTPRequest ConstructRequest(const std::string &url, Poco::Net::HTTPClientSession *&session, const std::vector< std::string > &headers, const std::string &request_type)
Definition Requests.cpp:79
std::vector< RequestData > RequestsVec_
Definition Requests.cpp:46
Requests(Requests &&)=delete
ARK_API bool CreateGetRequest(const std::string &url, const std::function< void(bool, std::string)> &callback, std::vector< std::string > headers={})
Creates an async GET Request that runs in another thread but calls the callback from the main thread.
Definition Requests.cpp:129
ARK_API bool CreatePostRequest(const std::string &url, const std::function< void(bool, std::string)> &callback, const std::vector< std::string > &post_ids, const std::vector< std::string > &post_data, std::vector< std::string > headers={})
Creates an async POST Request that runs in another thread but calls the callback from the main thread...
Definition Requests.cpp:238
Requests & operator=(Requests &&)=delete
ARK_API bool CreateDeleteRequest(const std::string &url, const std::function< void(bool, std::string)> &callback, std::vector< std::string > headers={})
Creates an async DELETE Request that runs in another thread but calls the callback from the main thre...
Definition Requests.cpp:292
Requests & operator=(const Requests &)=delete
ARK_API bool CreatePostRequest(const std::string &url, const std::function< void(bool, std::string)> &callback, const std::string &post_data, std::vector< std::string > headers={})
Creates an async POST Request with application/x-www-form-urlencoded content type that runs in anothe...
Definition Requests.cpp:162
static ARK_API Requests & Get()
Definition Requests.cpp:67
ARK_API bool CreatePostRequest(const std::string &url, const std::function< void(bool, std::string)> &callback, const std::string &post_data, const std::string &content_type, std::vector< std::string > headers={})
Creates an async POST Request that runs in another thread but calls the callback from the main thread...
Definition Requests.cpp:200
std::unique_ptr< impl > pimpl
Definition Requests.h:84
Requests(const Requests &)=delete
virtual void AddOnTickCallback(const FString &id, const std::function< void(float)> &callback)=0
Added function will be called every frame.
virtual bool RemoveOnTickCallback(const FString &id)=0
Removes a on-tick callback.
Definition Logger.h:9
static std::shared_ptr< spdlog::logger > & GetLog()
Definition Logger.h:22
std::string displayText() const
Returns the exception code if defined.
virtual std::istream & receiveResponse(HTTPResponse &response)
virtual std::ostream & sendRequest(HTTPRequest &request)
Returns the connection timeout for HTTP connections.
static const std::string HTTP_1_1
void setContentLength(std::streamsize length)
Returns the HTTP version for this message.
HTTPRequest(const std::string &method, const std::string &uri, const std::string &version)
Creates a HTTP/1.0 request with the given method and URI.
static const std::string HTTP_GET
static const std::string HTTP_DELETE
static const std::string HTTP_POST
const std::string & getReason() const
Sets the HTTP reason phrase.
HTTPResponse(HTTPStatus status)
HTTPStatus getStatus() const
HTTPSClientSession(const std::string &host, Poco::UInt16 port, Context::Ptr pContext, Session::Ptr pSession)
std::string proxyRequestPrefix() const
Sends the given HTTPRequest over an existing connection.
HTTPSClientSession(Context::Ptr pContext, Session::Ptr pSession)
HTTPSClientSession(Context::Ptr pContext)
Creates a HTTPSClientSession using the given host and port.
void proxyAuthenticate(HTTPRequest &request)
Checks if we can reuse a persistent connection.
int read(char *buffer, std::streamsize length)
HTTPSClientSession(const HTTPSClientSession &)
void connect(const SocketAddress &address)
Refills the internal buffer.
HTTPSClientSession(const SecureStreamSocket &socket, Session::Ptr pSession)
X509Certificate serverCertificate()
HTTPSClientSession & operator=(const HTTPSClientSession &)
HTTPSClientSession(const std::string &host, Poco::UInt16 port=HTTPS_PORT)
HTTPSClientSession(const SecureStreamSocket &socket)
Creates an unconnected HTTPSClientSession.
HTTPSClientSession(const std::string &host, Poco::UInt16 port, Context::Ptr pContext)
RejectCertificateHandler(bool handleErrorsOnServerSide)
void initializeClient(PrivateKeyPassphraseHandlerPtr ptrPassphraseHandler, InvalidCertificateHandlerPtr ptrHandler, Context::Ptr ptrContext)
static SSLManager & instance()
This stream discards all characters written to it.
Definition NullStream.h:77
static std::streamsize copyStream(std::istream &istr, std::ostream &ostr, std::size_t bufferSize=8192)
const std::string & getHost() const
Sets the user-info part of the URI.
Definition URI.h:385
const std::string & getScheme() const
Definition URI.h:373
URI(const std::string &uri)
Creates an empty URI.
unsigned short getPort() const
Sets the host part of the URI.
std::string getPathAndQuery() const
Returns the encoded path, query and fragment parts of the URI.
void error(const T &)
Definition IBaseApi.h:9
std::unique_ptr< IBaseApi > game_api
Definition IBaseApi.h:25
void NetSSL_API initializeSSL()
void Net_API uninitializeNetwork()
void Net_API initializeNetwork()
void NetSSL_API uninitializeSSL()
Definition format.h:408
Definition json.hpp:4518
std::function< void(bool, std::string)> callback
Definition Requests.cpp:41
static std::string escape(const std::string &s, bool strictJSON=false)