psocket.h

Go to the documentation of this file.

/*
 * The MIT License
 *
 * Copyright (C) 2010-2016 Alexander Saprykin <saprykin.spb@gmail.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * 'Software'), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#if !defined (PLIBSYS_H_INSIDE) && !defined (PLIBSYS_COMPILATION)
#  error "Header files shouldn't be included directly, consider using <plibsys.h> instead."
#endif

#ifndef PLIBSYS_HEADER_PSOCKET_H
#define PLIBSYS_HEADER_PSOCKET_H

#include <pmacros.h>
#include <psocketaddress.h>
#include <perror.h>

P_BEGIN_DECLS

typedef enum PSocketProtocol_ {
    P_SOCKET_PROTOCOL_UNKNOWN   = -1,   
    P_SOCKET_PROTOCOL_DEFAULT   = 0,    
    P_SOCKET_PROTOCOL_TCP       = 6,    
    P_SOCKET_PROTOCOL_UDP       = 17,   
    P_SOCKET_PROTOCOL_SCTP      = 132   
} PSocketProtocol;

typedef enum PSocketType_ {
    P_SOCKET_TYPE_UNKNOWN       = 0,    
    P_SOCKET_TYPE_STREAM        = 1,    
    P_SOCKET_TYPE_DATAGRAM      = 2,    
    P_SOCKET_TYPE_SEQPACKET     = 3 
} PSocketType;

typedef enum PSocketDirection_ {
    P_SOCKET_DIRECTION_SND      = 0,    
    P_SOCKET_DIRECTION_RCV      = 1 
} PSocketDirection;

typedef enum PSocketIOCondition_ {
    P_SOCKET_IO_CONDITION_POLLIN    = 1,    
    P_SOCKET_IO_CONDITION_POLLOUT   = 2 
} PSocketIOCondition;

typedef struct PSocket_ PSocket;

P_LIB_API PSocket *     p_socket_new_from_fd        (pint           fd,
                                 PError         **error);

P_LIB_API PSocket *     p_socket_new            (PSocketFamily      family,
                                 PSocketType        type,
                                 PSocketProtocol    protocol,
                                 PError         **error);

P_LIB_API pint          p_socket_get_fd         (const PSocket      *socket);

P_LIB_API PSocketFamily     p_socket_get_family         (const PSocket      *socket);

P_LIB_API PSocketType       p_socket_get_type       (const PSocket      *socket);

P_LIB_API PSocketProtocol   p_socket_get_protocol       (const PSocket      *socket);

P_LIB_API pboolean      p_socket_get_keepalive      (const PSocket      *socket);

P_LIB_API pboolean      p_socket_get_blocking       (PSocket        *socket);

P_LIB_API pint          p_socket_get_listen_backlog (const PSocket      *socket);

P_LIB_API pint          p_socket_get_timeout        (const PSocket      *socket);

P_LIB_API PSocketAddress *  p_socket_get_local_address  (const PSocket      *socket,
                                 PError         **error);

P_LIB_API PSocketAddress *  p_socket_get_remote_address (const PSocket      *socket,
                                 PError         **error);

P_LIB_API pboolean      p_socket_is_connected       (const PSocket      *socket);

P_LIB_API pboolean      p_socket_is_closed      (const PSocket      *socket);

P_LIB_API pboolean      p_socket_check_connect_result   (PSocket        *socket,
                                 PError         **error);

P_LIB_API void          p_socket_set_keepalive      (PSocket        *socket,
                                 pboolean       keepalive);

P_LIB_API void          p_socket_set_blocking       (PSocket        *socket,
                                 pboolean       blocking);

P_LIB_API void          p_socket_set_listen_backlog (PSocket        *socket,
                                 pint           backlog);

P_LIB_API void          p_socket_set_timeout        (PSocket        *socket,
                                 pint           timeout);

P_LIB_API pboolean      p_socket_bind           (const PSocket      *socket,
                                 PSocketAddress     *address,
                                 pboolean       allow_reuse,
                                 PError         **error);

P_LIB_API pboolean      p_socket_connect        (PSocket        *socket,
                                 PSocketAddress     *address,
                                 PError         **error);

P_LIB_API pboolean      p_socket_listen         (PSocket        *socket,
                                 PError         **error);

P_LIB_API PSocket *     p_socket_accept         (const PSocket      *socket,
                                 PError         **error);

P_LIB_API pssize        p_socket_receive        (const PSocket      *socket,
                                 pchar          *buffer,
                                 psize          buflen,
                                 PError         **error);

P_LIB_API pssize        p_socket_receive_from       (const PSocket      *socket,
                                 PSocketAddress     **address,
                                 pchar          *buffer,
                                 psize          buflen,
                                 PError         **error);

P_LIB_API pssize        p_socket_send           (const PSocket      *socket,
                                 const pchar        *buffer,
                                 psize          buflen,
                                 PError         **error);

P_LIB_API pssize        p_socket_send_to        (const PSocket      *socket,
                                 PSocketAddress     *address,
                                 const pchar        *buffer,
                                 psize          buflen,
                                 PError         **error);

P_LIB_API pboolean      p_socket_close          (PSocket        *socket,
                                 PError         **error);

P_LIB_API pboolean      p_socket_shutdown       (PSocket        *socket,
                                 pboolean       shutdown_read,
                                 pboolean       shutdown_write,
                                 PError         **error);

P_LIB_API void          p_socket_free           (PSocket        *socket);

P_LIB_API pboolean      p_socket_set_buffer_size    (const PSocket      *socket,
                                 PSocketDirection   dir,
                                 psize          size,
                                 PError         **error);

P_LIB_API pboolean      p_socket_io_condition_wait  (const PSocket      *socket,
                                 PSocketIOCondition condition,
                                 PError         **error);

P_END_DECLS

#endif /* PLIBSYS_HEADER_PSOCKET_H */