bsd_socket_misc.c File Reference

Helper function for BSD socket API. More...

#include "core/net.h"
#include "core/bsd_socket.h"
#include "core/bsd_socket_misc.h"
#include "debug.h"

Go to the source code of this file.

Macros

#define TRACE_LEVEL   BSD_SOCKET_TRACE_LEVEL
 

Functions

struct cmsghdrsocketCmsgFirstHdr (struct msghdr *msg)
 Get first ancillary data header. More...
 
struct cmsghdrsocketCmsgNextHdr (struct msghdr *msg, struct cmsghdr *cmsg)
 Get next ancillary data header. More...
 
void socketFdZero (fd_set *fds)
 Initializes a descriptor set. More...
 
void socketFdSet (fd_set *fds, int_t s)
 Add a descriptor to an existing set. More...
 
void socketFdClr (fd_set *fds, int_t s)
 Remove a descriptor from an existing set. More...
 
int_t socketFdIsSet (fd_set *fds, int_t s)
 Check whether a descriptor is set. More...
 
void socketSetErrnoCode (Socket *socket, uint_t errnoCode)
 Set BSD error code. More...
 
void socketTranslateErrorCode (Socket *socket, error_t errorCode)
 Translate error code. More...
 

Detailed Description

Helper function for BSD socket API.

License

SPDX-License-Identifier: GPL-2.0-or-later

Copyright (C) 2010-2024 Oryx Embedded SARL. All rights reserved.

This file is part of CycloneTCP Open.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

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, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author
Oryx Embedded SARL (www.oryx-embedded.com)
Version
2.4.4

Definition in file bsd_socket_misc.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL   BSD_SOCKET_TRACE_LEVEL

Definition at line 32 of file bsd_socket_misc.c.

Function Documentation

◆ socketCmsgFirstHdr()

struct cmsghdr* socketCmsgFirstHdr ( struct msghdr msg)

Get first ancillary data header.

Parameters
[in]msgPointer to the message header
Returns
Pointer to the first ancillary data header

Definition at line 50 of file bsd_socket_misc.c.

◆ socketCmsgNextHdr()

struct cmsghdr* socketCmsgNextHdr ( struct msghdr msg,
struct cmsghdr cmsg 
)

Get next ancillary data header.

Parameters
[in]msgPointer to the message header
[in]cmsgPointer to the current ancillary data header
Returns
Pointer to the next ancillary data header

Definition at line 80 of file bsd_socket_misc.c.

◆ socketFdClr()

void socketFdClr ( fd_set fds,
int_t  s 
)

Remove a descriptor from an existing set.

Parameters
[in]fdsPointer to a descriptor set
[in]sDescriptor that identifies the socket to remove

Definition at line 160 of file bsd_socket_misc.c.

◆ socketFdIsSet()

int_t socketFdIsSet ( fd_set fds,
int_t  s 
)

Check whether a descriptor is set.

Parameters
[in]fdsPointer to a descriptor set
[in]sDescriptor that identifies the socket to test
Returns
Nonzero if s is a member of the set. Otherwise, zero

Definition at line 194 of file bsd_socket_misc.c.

◆ socketFdSet()

void socketFdSet ( fd_set fds,
int_t  s 
)

Add a descriptor to an existing set.

Parameters
[in]fdsPointer to a descriptor set
[in]sDescriptor that identifies the socket to add

Definition at line 131 of file bsd_socket_misc.c.

◆ socketFdZero()

void socketFdZero ( fd_set fds)

Initializes a descriptor set.

Parameters
[in]fdsPointer to a descriptor set

Definition at line 118 of file bsd_socket_misc.c.

◆ socketSetErrnoCode()

void socketSetErrnoCode ( Socket socket,
uint_t  errnoCode 
)

Set BSD error code.

Parameters
[in]socketHandle that identifies a socket
[in]errnoCodeBSD error code

Definition at line 219 of file bsd_socket_misc.c.

◆ socketTranslateErrorCode()

void socketTranslateErrorCode ( Socket socket,
error_t  errorCode 
)

Translate error code.

Parameters
[in]socketHandle that identifies a socket
[in]errorCodeError code

Definition at line 239 of file bsd_socket_misc.c.