sm-ext-AsyncSocket/extension/extension.h

179 lines
5.7 KiB
C
Raw Normal View History

2015-05-21 19:29:14 +02:00
/**
* vim: set ts=4 :
* =============================================================================
* SourceMod Sample Extension
* Copyright (C) 2004-2008 AlliedModders LLC. All rights reserved.
* =============================================================================
*
* This program is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License, version 3.0, as published by the
* Free Software Foundation.
*
2015-05-21 19:29:14 +02:00
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
* details.
*
* You should have received a copy of the GNU General Public License along with
* this program. If not, see <http://www.gnu.org/licenses/>.
*
* As a special exception, AlliedModders LLC gives you permission to link the
* code of this program (as well as its derivative works) to "Half-Life 2," the
* "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
* by the Valve Corporation. You must obey the GNU General Public License in
* all respects for all other code used. Additionally, AlliedModders LLC grants
* this exception to all derivative works. AlliedModders LLC defines further
* exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
* or <http://www.sourcemod.net/license.php>.
*
* Version: $Id$
*/
#ifndef _INCLUDE_SOURCEMOD_EXTENSION_PROPER_H_
#define _INCLUDE_SOURCEMOD_EXTENSION_PROPER_H_
/**
* @file extension.h
* @brief Sample extension code header.
*/
#include <stdlib.h>
#include <string.h>
#include "smsdk_ext.h"
#include "context.h"
struct CAsyncAddJob
{
uv_async_cb CallbackFn;
void *pData;
};
struct CAsyncWrite
{
CAsyncSocketContext *pSocketContext;
uv_buf_t *pBuffer;
2015-05-21 19:29:14 +02:00
};
struct CSocketConnect
{
CAsyncSocketContext *pSocketContext;
uv_stream_t *pClientSocket;
};
struct CSocketData
{
CAsyncSocketContext *pSocketContext;
char *pBuffer;
ssize_t BufferSize;
2015-05-21 19:29:14 +02:00
};
struct CSocketError
{
CAsyncSocketContext *pSocketContext;
int Error;
2015-05-21 19:29:14 +02:00
};
void UV_EventLoop(void *data);
void UV_OnAsyncAdded(uv_async_t *pHandle);
void UV_FreeHandle(uv_handle_t *handle);
void UV_AllocBuffer(uv_handle_t *handle, size_t suggested_size, uv_buf_t *buf);
void UV_Quit(uv_async_t *pHandle);
void UV_DeleteAsyncContext(uv_async_t *pHandle);
void UV_PushError(CAsyncSocketContext *pContext, int error);
void UV_OnRead(uv_stream_t *client, ssize_t nread, const uv_buf_t *buf);
void UV_OnConnect(uv_connect_t *req, int status);
void UV_StartRead(uv_async_t *pHandle);
void UV_OnNewConnection(uv_stream_t *server, int status);
void UV_OnAsyncResolved(uv_getaddrinfo_t *resolver, int status, struct addrinfo *res);
void UV_OnAsyncResolve(uv_async_t *handle);
void UV_OnAsyncWriteCleanup(uv_write_t *req, int status);
void UV_OnAsyncWrite(uv_async_t *handle);
void UV_OnWalk(uv_handle_t *pHandle, void *pArg);
2015-05-21 19:29:14 +02:00
/**
* @brief Sample implementation of the SDK Extension.
* Note: Uncomment one of the pre-defined virtual functions in order to use it.
*/
class AsyncSocket : public SDKExtension, public IHandleTypeDispatch
{
public:
/**
* @brief This is called after the initial loading sequence has been processed.
*
* @param error Error message buffer.
* @param maxlength Size of error message buffer.
* @param late Whether or not the module was loaded after map load.
* @return True to succeed loading, false to fail.
*/
virtual bool SDK_OnLoad(char *error, size_t maxlength, bool late);
2015-05-21 19:29:14 +02:00
/**
* @brief This is called right before the extension is unloaded.
*/
virtual void SDK_OnUnload();
/**
* @brief This is called once all known extensions have been loaded.
* Note: It is is a good idea to add natives here, if any are provided.
*/
//virtual void SDK_OnAllLoaded();
/**
* @brief Called when the pause state is changed.
*/
//virtual void SDK_OnPauseChange(bool paused);
/**
* @brief this is called when Core wants to know if your extension is working.
*
* @param error Error message buffer.
* @param maxlength Size of error message buffer.
* @return True if working, false otherwise.
*/
//virtual bool QueryRunning(char *error, size_t maxlength);
public:
#if defined SMEXT_CONF_METAMOD
/**
* @brief Called when Metamod is attached, before the extension version is called.
*
* @param error Error buffer.
* @param maxlength Maximum size of error buffer.
* @param late Whether or not Metamod considers this a late load.
* @return True to succeed, false to fail.
*/
//virtual bool SDK_OnMetamodLoad(ISmmAPI *ismm, char *error, size_t maxlength, bool late);
/**
* @brief Called when Metamod is detaching, after the extension version is called.
* NOTE: By default this is blocked unless sent from SourceMod.
*
* @param error Error buffer.
* @param maxlength Maximum size of error buffer.
* @return True to succeed, false to fail.
*/
//virtual bool SDK_OnMetamodUnload(char *error, size_t maxlength);
/**
* @brief Called when Metamod's pause state is changing.
* NOTE: By default this is blocked unless sent from SourceMod.
*
* @param paused Pause state being set.
* @param error Error buffer.
* @param maxlength Maximum size of error buffer.
* @return True to succeed, false to fail.
*/
//virtual bool SDK_OnMetamodPauseChange(bool paused, char *error, size_t maxlength);
#endif
public:
HandleType_t socketHandleType;
CAsyncSocketContext* GetSocketInstanceByHandle(Handle_t handle);
2015-05-21 19:29:14 +02:00
public:
void OnHandleDestroy(HandleType_t type, void *object);
};
extern const sp_nativeinfo_t AsyncSocketNatives[];
#endif // _INCLUDE_SOURCEMOD_EXTENSION_PROPER_H_