socket_misc.h File Reference

Helper functions for sockets. More...

#include "core/net.h"
#include "core/socket.h"

Go to the source code of this file.

Functions

SocketsocketAllocate (uint_t type, uint_t protocol)
 Allocate a socket. More...
 
void socketRegisterEvents (Socket *socket, OsEvent *event, uint_t eventMask)
 Subscribe to the specified socket events. More...
 
void socketUnregisterEvents (Socket *socket)
 Unsubscribe previously registered events. More...
 
uint_t socketGetEvents (Socket *socket)
 Retrieve event flags for a specified socket. More...
 

Detailed Description

Helper functions for sockets.

License

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

Copyright (C) 2010-2022 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.2.0

Definition in file socket_misc.h.

Function Documentation

◆ socketAllocate()

Socket* socketAllocate ( uint_t  type,
uint_t  protocol 
)

Allocate a socket.

Parameters
[in]typeType specification for the new socket
[in]protocolProtocol to be used
Returns
Handle referencing the new socket

Definition at line 53 of file socket_misc.c.

◆ socketGetEvents()

uint_t socketGetEvents ( Socket socket)

Retrieve event flags for a specified socket.

Parameters
[in]socketHandle that identifies a socket
Returns
Logic OR of events in the signaled state

Definition at line 273 of file socket_misc.c.

◆ socketRegisterEvents()

void socketRegisterEvents ( Socket socket,
OsEvent event,
uint_t  eventMask 
)

Subscribe to the specified socket events.

Parameters
[in]socketHandle that identifies a socket
[in]eventEvent object used to receive notifications
[in]eventMaskLogic OR of the requested socket events

Definition at line 195 of file socket_misc.c.

◆ socketUnregisterEvents()

void socketUnregisterEvents ( Socket socket)

Unsubscribe previously registered events.

Parameters
[in]socketHandle that identifies a socket

Definition at line 250 of file socket_misc.c.