Browse Source
git-svn-id: https://nuttx.svn.sourceforge.net/svnroot/nuttx/trunk@4349 7fd9a85b-ad96-42d3-883c-3090e2eb8679sbg
patacongo
13 years ago
8 changed files with 80 additions and 335 deletions
@ -1,312 +0,0 @@
@@ -1,312 +0,0 @@
|
||||
/****************************************************************************
|
||||
* include/net/psock.h |
||||
* |
||||
* Copyright (C) 2012 Gregory Nutt. All rights reserved. |
||||
* Author: Gregory Nutt <gnutt@nuttx.org> |
||||
* |
||||
* Redistribution and use in source and binary forms, with or without |
||||
* modification, are permitted provided that the following conditions |
||||
* are met: |
||||
* |
||||
* 1. Redistributions of source code must retain the above copyright |
||||
* notice, this list of conditions and the following disclaimer. |
||||
* 2. Redistributions in binary form must reproduce the above copyright |
||||
* notice, this list of conditions and the following disclaimer in |
||||
* the documentation and/or other materials provided with the |
||||
* distribution. |
||||
* 3. Neither the name NuttX nor the names of its contributors may be |
||||
* used to endorse or promote products derived from this software |
||||
* without specific prior written permission. |
||||
* |
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
||||
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
||||
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS |
||||
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE |
||||
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, |
||||
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, |
||||
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS |
||||
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED |
||||
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
||||
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN |
||||
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
||||
* POSSIBILITY OF SUCH DAMAGE. |
||||
* |
||||
****************************************************************************/ |
||||
|
||||
#ifndef __NET_PSOCK_H |
||||
#define __NET_PSOCK_H |
||||
|
||||
/****************************************************************************
|
||||
* Included Files |
||||
****************************************************************************/ |
||||
|
||||
#include <nuttx/config.h> |
||||
#include <sys/types.h> |
||||
|
||||
#ifdef CONFIG_NET |
||||
|
||||
/****************************************************************************
|
||||
* Pre-Processor Definitions |
||||
****************************************************************************/ |
||||
|
||||
/****************************************************************************
|
||||
* Public Type Definitions |
||||
****************************************************************************/ |
||||
|
||||
/****************************************************************************
|
||||
* Public Function Prototypes |
||||
****************************************************************************/ |
||||
|
||||
#undef EXTERN |
||||
#if defined(__cplusplus) |
||||
#define EXTERN extern "C" |
||||
extern "C" { |
||||
#else |
||||
#define EXTERN extern |
||||
#endif |
||||
|
||||
/****************************************************************************
|
||||
* Function: sockfd_socket |
||||
* |
||||
* Description: |
||||
* Given a socket descriptor, return the underly NuttX-specific socket |
||||
* structure. |
||||
* |
||||
* Parameters: |
||||
* psock Socket instance |
||||
* |
||||
* Returned Value: |
||||
* 0 on success; -1 on error with errno set appropriately. |
||||
* |
||||
* Assumptions: |
||||
* |
||||
****************************************************************************/ |
||||
|
||||
struct socket; |
||||
EXTERN FAR struct socket *sockfd_socket(int sockfd); |
||||
|
||||
/****************************************************************************
|
||||
* Function: psock_close |
||||
* |
||||
* Description: |
||||
* Performs the close operation on a socket instance |
||||
* |
||||
* Parameters: |
||||
* psock Socket instance |
||||
* |
||||
* Returned Value: |
||||
* 0 on success; -1 on error with errno set appropriately. |
||||
* |
||||
* Assumptions: |
||||
* |
||||
****************************************************************************/ |
||||
|
||||
struct socket; |
||||
EXTERN int psock_close(FAR struct socket *psock); |
||||
|
||||
/****************************************************************************
|
||||
* Function: psock_send |
||||
* |
||||
* Description: |
||||
* The send() call may be used only when the socket is in a connected state |
||||
* (so that the intended recipient is known). The only difference between |
||||
* send() and write() is the presence of flags. With zero flags parameter, |
||||
* send() is equivalent to write(). Also, send(sockfd,buf,len,flags) is |
||||
* equivalent to sendto(sockfd,buf,len,flags,NULL,0). |
||||
* |
||||
* Parameters: |
||||
* psock And instance of the internal socket structure. |
||||
* buf Data to send |
||||
* len Length of data to send |
||||
* flags Send flags |
||||
* |
||||
* Returned Value: |
||||
* On success, returns the number of characters sent. On error, |
||||
* -1 is returned, and errno is set appropriately: |
||||
* |
||||
* EAGAIN or EWOULDBLOCK |
||||
* The socket is marked non-blocking and the requested operation |
||||
* would block. |
||||
* EBADF |
||||
* An invalid descriptor was specified. |
||||
* ECONNRESET |
||||
* Connection reset by peer. |
||||
* EDESTADDRREQ |
||||
* The socket is not connection-mode, and no peer address is set. |
||||
* EFAULT |
||||
* An invalid user space address was specified for a parameter. |
||||
* EINTR |
||||
* A signal occurred before any data was transmitted. |
||||
* EINVAL |
||||
* Invalid argument passed. |
||||
* EISCONN |
||||
* The connection-mode socket was connected already but a recipient |
||||
* was specified. (Now either this error is returned, or the recipient |
||||
* specification is ignored.) |
||||
* EMSGSIZE |
||||
* The socket type requires that message be sent atomically, and the |
||||
* size of the message to be sent made this impossible. |
||||
* ENOBUFS |
||||
* The output queue for a network interface was full. This generally |
||||
* indicates that the interface has stopped sending, but may be |
||||
* caused by transient congestion. |
||||
* ENOMEM |
||||
* No memory available. |
||||
* ENOTCONN |
||||
* The socket is not connected, and no target has been given. |
||||
* ENOTSOCK |
||||
* The argument s is not a socket. |
||||
* EOPNOTSUPP |
||||
* Some bit in the flags argument is inappropriate for the socket |
||||
* type. |
||||
* EPIPE |
||||
* The local end has been shut down on a connection oriented socket. |
||||
* In this case the process will also receive a SIGPIPE unless |
||||
* MSG_NOSIGNAL is set. |
||||
* |
||||
* Assumptions: |
||||
* |
||||
****************************************************************************/ |
||||
|
||||
struct socket; |
||||
EXTERN ssize_t psock_send(FAR struct socket *psock, const void *buf, |
||||
size_t len, int flags); |
||||
|
||||
/****************************************************************************
|
||||
* Function: psock_sendto |
||||
* |
||||
* Description: |
||||
* If sendto() is used on a connection-mode (SOCK_STREAM, SOCK_SEQPACKET) |
||||
* socket, the parameters to and 'tolen' are ignored (and the error EISCONN |
||||
* may be returned when they are not NULL and 0), and the error ENOTCONN is |
||||
* returned when the socket was not actually connected. |
||||
* |
||||
* Parameters: |
||||
* psock A pointer to a NuttX-specific, internal socket structure |
||||
* buf Data to send |
||||
* len Length of data to send |
||||
* flags Send flags |
||||
* to Address of recipient |
||||
* tolen The length of the address structure |
||||
* |
||||
* Returned Value: |
||||
* On success, returns the number of characters sent. On error, |
||||
* -1 is returned, and errno is set appropriately: |
||||
* |
||||
* EAGAIN or EWOULDBLOCK |
||||
* The socket is marked non-blocking and the requested operation |
||||
* would block. |
||||
* EBADF |
||||
* An invalid descriptor was specified. |
||||
* ECONNRESET |
||||
* Connection reset by peer. |
||||
* EDESTADDRREQ |
||||
* The socket is not connection-mode, and no peer address is set. |
||||
* EFAULT |
||||
* An invalid user space address was specified for a parameter. |
||||
* EINTR |
||||
* A signal occurred before any data was transmitted. |
||||
* EINVAL |
||||
* Invalid argument passed. |
||||
* EISCONN |
||||
* The connection-mode socket was connected already but a recipient |
||||
* was specified. (Now either this error is returned, or the recipient |
||||
* specification is ignored.) |
||||
* EMSGSIZE |
||||
* The socket type requires that message be sent atomically, and the |
||||
* size of the message to be sent made this impossible. |
||||
* ENOBUFS |
||||
* The output queue for a network interface was full. This generally |
||||
* indicates that the interface has stopped sending, but may be |
||||
* caused by transient congestion. |
||||
* ENOMEM |
||||
* No memory available. |
||||
* ENOTCONN |
||||
* The socket is not connected, and no target has been given. |
||||
* ENOTSOCK |
||||
* The argument s is not a socket. |
||||
* EOPNOTSUPP |
||||
* Some bit in the flags argument is inappropriate for the socket |
||||
* type. |
||||
* EPIPE |
||||
* The local end has been shut down on a connection oriented socket. |
||||
* In this case the process will also receive a SIGPIPE unless |
||||
* MSG_NOSIGNAL is set. |
||||
* |
||||
* Assumptions: |
||||
* |
||||
****************************************************************************/ |
||||
|
||||
struct socket; |
||||
struct sockaddr; |
||||
EXTERN ssize_t psock_sendto(FAR struct socket *psock, FAR const void *buf, |
||||
size_t len, int flags, FAR const struct sockaddr *to, |
||||
socklen_t tolen); |
||||
|
||||
/****************************************************************************
|
||||
* Function: psock_recvfrom |
||||
* |
||||
* Description: |
||||
* recvfrom() receives messages from a socket, and may be used to receive |
||||
* data on a socket whether or not it is connection-oriented. |
||||
* |
||||
* If from is not NULL, and the underlying protocol provides the source |
||||
* address, this source address is filled in. The argument fromlen |
||||
* initialized to the size of the buffer associated with from, and modified |
||||
* on return to indicate the actual size of the address stored there. |
||||
* |
||||
* Parameters: |
||||
* psock A pointer to a NuttX-specific, internal socket structure |
||||
* buf Buffer to receive data |
||||
* len Length of buffer |
||||
* flags Receive flags |
||||
* from Address of source (may be NULL) |
||||
* fromlen The length of the address structure |
||||
* |
||||
* Returned Value: |
||||
* On success, returns the number of characters sent. On error, |
||||
* -1 is returned, and errno is set appropriately: |
||||
* |
||||
* EAGAIN |
||||
* The socket is marked non-blocking and the receive operation would block, |
||||
* or a receive timeout had been set and the timeout expired before data |
||||
* was received. |
||||
* EBADF |
||||
* The argument sockfd is an invalid descriptor. |
||||
* ECONNREFUSED |
||||
* A remote host refused to allow the network connection (typically because |
||||
* it is not running the requested service). |
||||
* EFAULT |
||||
* The receive buffer pointer(s) point outside the process's address space. |
||||
* EINTR |
||||
* The receive was interrupted by delivery of a signal before any data were |
||||
* available. |
||||
* EINVAL |
||||
* Invalid argument passed. |
||||
* ENOMEM |
||||
* Could not allocate memory. |
||||
* ENOTCONN |
||||
* The socket is associated with a connection-oriented protocol and has |
||||
* not been connected. |
||||
* ENOTSOCK |
||||
* The argument sockfd does not refer to a socket. |
||||
* |
||||
* Assumptions: |
||||
* |
||||
****************************************************************************/ |
||||
|
||||
struct socket; |
||||
struct sockaddr; |
||||
EXTERN ssize_t psock_recvfrom(FAR struct socket *psock, FAR void *buf, |
||||
size_t len, int flags,FAR struct sockaddr *from, |
||||
FAR socklen_t *fromlen); |
||||
|
||||
#define psock_recv(psock,buf,len,flags) psock_recvfrom(psock,buf,len,flags,NULL,0) |
||||
|
||||
#undef EXTERN |
||||
#if defined(__cplusplus) |
||||
} |
||||
#endif |
||||
|
||||
#endif /* CONFIG_NET */ |
||||
#endif /* __NET_PSOCK_H */ |
||||
Loading…
Reference in new issue