lwpa_socket.h

/******************************************************************************
 * Copyright 2018 ETC Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *******************************************************************************
 * This file is a part of lwpa. For more information, go to:
 * https://github.com/ETCLabs/lwpa
 ******************************************************************************/
 
/* lwpa_socket.h: Platform-neutral BSD-modeled network socket
 * implementation. */
#ifndef _LWPA_SOCKET_H_
#define _LWPA_SOCKET_H_
 
#include <stddef.h>
#include "lwpa_common.h"
#include "lwpa_bool.h"
#include "lwpa_error.h"
#include "lwpa_inet.h"
#include "lwpa_socket_plat.h"
 
/* clang-format off */
 
#define LWPA_MSG_PEEK 0x1
/* Note: no flags are currently implemented for lwpa_sendto() */
 
#define LWPA_SOL_SOCKET     0 
#define LWPA_IPPROTO_IP     1 
#define LWPA_IPPROTO_ICMPV6 2 
#define LWPA_IPPROTO_IPV6   3 
#define LWPA_IPPROTO_TCP    4 
#define LWPA_IPPROTO_UDP    5 
#define LWPA_SO_BROADCAST 0  
#define LWPA_SO_ERROR     1  
#define LWPA_SO_KEEPALIVE 2  
#define LWPA_SO_LINGER    3  
#define LWPA_SO_RCVBUF    4  
#define LWPA_SO_SNDBUF    5  
#define LWPA_SO_RCVTIMEO  6  
#define LWPA_SO_SNDTIMEO  7  
#define LWPA_SO_REUSEADDR 8  
#define LWPA_SO_REUSEPORT 9  
#define LWPA_SO_TYPE      10 
#define LWPA_IP_TTL            11 
#define LWPA_IP_MULTICAST_IF   12 
#define LWPA_IP_MULTICAST_TTL  13 
#define LWPA_IP_MULTICAST_LOOP 14 
#define LWPA_MCAST_JOIN_GROUP  15 
#define LWPA_MCAST_LEAVE_GROUP 16 
/* clang-format on */
 
/* LWPA_IPPROTO_TCP: TODO */
 
typedef struct LwpaLinger
{
  int onoff;  
  int linger; 
} LwpaLinger;
 
typedef struct LwpaMreq
{
  LwpaIpAddr netint;
  LwpaIpAddr group;
} LwpaMreq;
 
#define LWPA_SHUT_RD 0
#define LWPA_SHUT_WR 1
#define LWPA_SHUT_RDWR 2
#define LWPA_AF_UNSPEC 0
#define LWPA_AF_INET 1
#define LWPA_AF_INET6 2
#define LWPA_STREAM 0
#define LWPA_DGRAM 1
/********************** Mimic sys/socket.h functions *************************/
 
#ifdef __cplusplus
extern "C" {
#endif
 
lwpa_error_t lwpa_socket_init(void *platform_data);
void lwpa_socket_deinit();
 
lwpa_error_t lwpa_accept(lwpa_socket_t id, LwpaSockaddr *address, lwpa_socket_t *conn_sock);
lwpa_error_t lwpa_bind(lwpa_socket_t id, const LwpaSockaddr *address);
lwpa_error_t lwpa_close(lwpa_socket_t id);
lwpa_error_t lwpa_connect(lwpa_socket_t id, const LwpaSockaddr *address);
lwpa_error_t lwpa_getpeername(lwpa_socket_t id, LwpaSockaddr *address);
lwpa_error_t lwpa_getsockname(lwpa_socket_t id, LwpaSockaddr *address);
lwpa_error_t lwpa_getsockopt(lwpa_socket_t id, int level, int option_name, void *option_value, size_t *option_len);
lwpa_error_t lwpa_listen(lwpa_socket_t id, int backlog);
int lwpa_recv(lwpa_socket_t id, void *buffer, size_t length, int flags);
int lwpa_recvfrom(lwpa_socket_t id, void *buffer, size_t length, int flags, LwpaSockaddr *address);
/* recvmsg - not implemented */
int lwpa_send(lwpa_socket_t id, const void *message, size_t length, int flags);
/* sendmsg - not implemented */
int lwpa_sendto(lwpa_socket_t id, const void *message, size_t length, int flags, const LwpaSockaddr *dest_addr);
lwpa_error_t lwpa_setsockopt(lwpa_socket_t id, int level, int option_name, const void *option_value, size_t option_len);
lwpa_error_t lwpa_shutdown(lwpa_socket_t id, int how);
lwpa_socket_t lwpa_socket(unsigned int family, unsigned int type);
/* int protocol - not necessary */
/* socketpair - not implemented */
 
/**************************** Mimic fcntl() API ******************************/
 
lwpa_error_t lwpa_setblocking(lwpa_socket_t id, bool blocking);
 
/**************************** Mimic poll() API *******************************/
 
#define LWPA_POLLIN 0x1
#define LWPA_POLLOUT 0x2
#define LWPA_POLLPRI 0x4
#define LWPA_POLLERR 0x8
typedef struct LwpaPollfd
{
  lwpa_socket_t fd; 
  short events;     
  short revents;    
  lwpa_error_t err; 
} LwpaPollfd;
 
int lwpa_poll(LwpaPollfd *fds, size_t nfds, int timeout_ms);
 
/************************ Mimic getaddrinfo() API ****************************/
 
#define LWPA_AI_PASSIVE 0x01
#define LWPA_AI_CANONNAME 0x02
#define LWPA_AI_NUMERICHOST 0x04
typedef struct LwpaAddrinfo
{
  int ai_flags;         
  int ai_family;        
  int ai_socktype;      
  int ai_protocol;      
  char *ai_canonname;   
  LwpaSockaddr ai_addr; 
  void *pd[2];          
} LwpaAddrinfo;
 
lwpa_error_t lwpa_getaddrinfo(const char *hostname, const char *service, const LwpaAddrinfo *hints,
                              LwpaAddrinfo *result);
 
bool lwpa_nextaddr(LwpaAddrinfo *ai);
 
/* Call with any of the LwpaAddrinfos in the list to free the whole
 * list */
void lwpa_freeaddrinfo(LwpaAddrinfo *ai);
 
/************************* Mimic inet_xtox() API *****************************/
 
#define LWPA_INET_ADDRSTRLEN 16
#define LWPA_INET6_ADDRSTRLEN 46
 
lwpa_error_t lwpa_inet_ntop(const LwpaIpAddr *src, char *dest, size_t size);
lwpa_error_t lwpa_inet_pton(lwpa_iptype_t type, const char *src, LwpaIpAddr *dest);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _LWPA_SOCKET_H_ */