mirror of
https://github.com/alliedmodders/amxmodx.git
synced 2025-03-13 06:00:22 +03:00
3c49064308
- Fixed the backwards compatibility with the return codes - Merged socket_connect and socket_connect_nb - Added a 5th parameter to socket_open that takes bit flags to enable the new features (libc errors & nonblocking sockets) - Fixed an error on socket_send2 that caused the buffet not to start from the beginning if multiple calls were made - Updated docs - [docs] Prefixed error codes with SOCK_ - [docs] Added the new flags SOCK_NON_BLOCKING and SOCK_LIBC_ERRORS - [docs] Added a new stock called SOCK_ERROR_EINPROGRESS(error) to be used when checking if a newly created nonblocking socket is connecting
172 lines
6.5 KiB
SourcePawn
Executable File
172 lines
6.5 KiB
SourcePawn
Executable File
// vim: set ts=4 sw=4 tw=99 noet:
|
|
//
|
|
// AMX Mod X, based on AMX Mod by Aleksander Naszko ("OLO").
|
|
// Copyright (C) The AMX Mod X Development Team.
|
|
//
|
|
// This software is licensed under the GNU General Public License, version 3 or higher.
|
|
// Additional exceptions apply. For full license details, see LICENSE.txt or visit:
|
|
// https://alliedmods.net/amxmodx-license
|
|
|
|
//
|
|
// Socket Functions
|
|
//
|
|
|
|
#if defined _socket_included
|
|
#endinput
|
|
#endif
|
|
#define _socket_included
|
|
|
|
#pragma reqlib sockets
|
|
#if !defined AMXMODX_NOAUTOLOAD
|
|
#pragma loadlib sockets
|
|
#endif
|
|
|
|
// Socket flags
|
|
#define SOCK_NON_BLOCKING (1 << 0) // Set the socket a nonblocking
|
|
#define SOCK_LIBC_ERRORS (1 << 1) // Enable libc error reporting
|
|
|
|
// Error reporting
|
|
#define SOCK_ERROR_OK 0 // No error
|
|
#define SOCK_ERROR_CREATE_SOCKET 1 // Couldn't create a socket
|
|
#define SOCK_ERROR_SERVER_UNKNOWN 2 // Server unknown
|
|
#define SOCK_ERROR_WHILE_CONNECTING 3 // Error while connecting
|
|
|
|
// Nonblocking sockets error handler
|
|
stock SOCK_ERROR_EINPROGRESS(error) return (error == 0 || error == 10035 || error == 10036 || error == 115)
|
|
|
|
// Socket connection type (TCP/UDP)
|
|
#define SOCKET_TCP 1
|
|
#define SOCKET_UDP 2
|
|
|
|
/**
|
|
* Connects to the given node and service via TCP/UDP.
|
|
*
|
|
* @note There's 2 types of error reporting on this function that you can use, for backwards compatibility reasons libc errors are disabled by default
|
|
* @note Old, default error codes:
|
|
* 0 - No error
|
|
* 1 - Error while creating socket
|
|
* 2 - Couldn't resolve hostname
|
|
* 3 - Couldn't connect
|
|
* @note New, libc error codes:
|
|
* https://www.gnu.org/software/libc/manual/html_node/Error-Codes.html
|
|
* https://github.com/torvalds/linux/blob/master/include/uapi/asm-generic/errno.h
|
|
* https://msdn.microsoft.com/en-us/library/ms740668.aspx
|
|
*
|
|
* @note The currently available bit flags are:
|
|
* - SOCK_NON_BLOCKING : if set, the socket would be on nonblocking mode
|
|
* - SOCK_LIBC_ERRORS : if set, the new libc errors will be seen on _error instead of the old, made up ones
|
|
* @note If no flags are set, the behaviour of the function will not be modified (default blocking mode and error reporting).
|
|
* @note Multiple flags may be set at the same time using the | operator. For example, SOCK_NON_BLOCKING|SOCK_LIBC_ERRORS will create a nonblocking socket with libc error codes.
|
|
*
|
|
* @note If you're creating a new nonblocking socket, _hostname should be numeric to avoid calling the name resolution server and potentially blocking the call
|
|
* @note If the socket is a nonblocking one, the returned socket descriptor may be still connecting and further checks should be done with socket_is_writable() before trying to send data
|
|
*
|
|
* @param _hostname Node to connect to
|
|
* @param _port Service to connect to
|
|
* @param _protocol Connect via SOCKET_TCP or SOCKET_UDP
|
|
* @param _error Set an error code here if anything goes wrong
|
|
* @param _flags Optional bit flags that change the behaviour of the function
|
|
*
|
|
* @return A socket descriptor (a positive integer) on success
|
|
* -1 on failure
|
|
*/
|
|
native socket_open(const _hostname[], _port, _protocol = SOCKET_TCP, &_error, _flags = 0);
|
|
|
|
/**
|
|
* Closes a socket
|
|
*
|
|
* @param _socket Socket descriptor
|
|
*
|
|
* @return 1 on success
|
|
* -1 on failure
|
|
*/
|
|
native socket_close(_socket);
|
|
|
|
/**
|
|
* Receives data.
|
|
*
|
|
* @note The ammount of bytes than you end up receiving can be less than the one you expected
|
|
*
|
|
* @param _socket Socket descriptor
|
|
* @param _data Array to save the data
|
|
* @param _length Length of the array
|
|
*
|
|
* @return Ammount of bytes received
|
|
* 0 if the peer closed the connection
|
|
* -1 on failure
|
|
*/
|
|
native socket_recv(_socket, _data[], _length);
|
|
|
|
/**
|
|
* Sends data.
|
|
*
|
|
* @note The ammount of bytes than you end up sending can be less than expected, you're responsible of sending the rest later
|
|
*
|
|
* @param _socket Socket descriptor
|
|
* @param _data Array with the data to send
|
|
* @param _length Length of the array
|
|
*
|
|
* @return Ammount of bytes sent
|
|
* -1 on failure
|
|
*/
|
|
native socket_send(_socket, const _data[], _length);
|
|
|
|
/**
|
|
* Sends data that can contain null bytes.
|
|
*
|
|
* @note The ammount of bytes than you end up sending can be less than expected, you're responsible of sending the rest later
|
|
*
|
|
* @param _socket Socket descriptor
|
|
* @param _data Array with the data to send
|
|
* @param _length Length of the array
|
|
*
|
|
* @return Ammount of bytes sent
|
|
* -1 on failure
|
|
*/
|
|
native socket_send2(_socket, const _data[], _length);
|
|
|
|
/**
|
|
* Check if a socket is marked as readable.
|
|
*
|
|
* @note You can use this function to make sure there's something on the socket and avoiding a blocking call
|
|
* @note Set _timeout to 0 avoid blocking the call
|
|
* @note A socket will become readable if there's any data or an EOF
|
|
*
|
|
* @param _socket Socket descriptor
|
|
* @param _timeout Ammount of time to block the call waiting for the socket to be marked as readable or for the timeout to expire, in µSeconds (1 sec = 1000000 µsec)
|
|
*
|
|
* @return 1 if the socket is marked as readable
|
|
* -1 otherwise
|
|
*/
|
|
native socket_change(_socket, _timeout = 100000);
|
|
|
|
/**
|
|
* Check if a socket is marked as readable.
|
|
*
|
|
* @note You can use this function to make sure there's something on the socket and avoiding a blocking call
|
|
* @note Set _timeout to 0 avoid blocking the call
|
|
* @note A socket will become readable if there's any data or an EOF
|
|
*
|
|
* @param _socket Socket descriptor
|
|
* @param _timeout Ammount of time to block the call waiting for the socket to be marked as readable or for the timeout to expire, in µSeconds (1 sec = 1000000 µsec)
|
|
*
|
|
* @return 1 if the socket is marked as readable
|
|
* -1 otherwise
|
|
*/
|
|
native socket_is_readable(_socket, _timeout = 100000);
|
|
|
|
/**
|
|
* Check if a socket is marked as writable.
|
|
*
|
|
* @note Use this function to check if a nonblocking socket is ready to be used
|
|
* @note Set _timeout to 0 avoid blocking the call
|
|
* @note An UDP socket is always writable
|
|
*
|
|
* @param _socket Socket descriptor
|
|
* @param _timeout Ammount of time to block the call waiting for the socket to be marked as writable or for the timeout to expire, in µSeconds (1 sec = 1000000 µsec)
|
|
*
|
|
* @return 1 if the socket is marked as writable
|
|
* -1 otherwise
|
|
*/
|
|
native socket_is_writable(_socket, _timeout = 100000);
|