de5a6163d5
Squashed commit of the following: net/: Fix some naming inconsistencies, Fix final compilation issies. net/inet/inet_close(): Now that we have logic to drain the buffered TX data, we can implement a proper lingering close. net/inet,tcp,udp: Add functions to wait for write buffers to drain. net/udp: Add support for notification when the UDP write buffer becomes empty. net/tcp: Add support for notification when the TCP write buffer becomes empty.
111 lines
3.6 KiB
C
111 lines
3.6 KiB
C
/****************************************************************************
|
|
* net/inet/inet_txdrain.c
|
|
*
|
|
* Copyright (C) 2019 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.
|
|
*
|
|
****************************************************************************/
|
|
|
|
/****************************************************************************
|
|
* Included Files
|
|
****************************************************************************/
|
|
|
|
#include <nuttx/config.h>
|
|
|
|
#include <sys/types.h>
|
|
#include <sys/socket.h>
|
|
|
|
#include <string.h>
|
|
#include <errno.h>
|
|
#include <assert.h>
|
|
|
|
#include <nuttx/net/net.h>
|
|
|
|
#include "udp/udp.h"
|
|
#include "tcp/tcp.h"
|
|
#include "inet/inet.h"
|
|
|
|
/****************************************************************************
|
|
* Public Functions
|
|
****************************************************************************/
|
|
|
|
/****************************************************************************
|
|
* Name: inet_txdrain
|
|
*
|
|
* Description:
|
|
* Wait for any buffered Tx data to be sent from the socket. This is part
|
|
* of the implementation of SO_LINGER
|
|
*
|
|
* Parameters:
|
|
* psock - Pointer to the socket structure instance
|
|
* abstime - The absolute time when the timeout will occur
|
|
*
|
|
* Returned Value:
|
|
* Zero (OK) is returned on success; a negated error value is returned on
|
|
* any failure.
|
|
*
|
|
****************************************************************************/
|
|
|
|
int inet_txdrain(FAR struct socket *psock,
|
|
FAR const struct timespec *abstime)
|
|
{
|
|
int ret = OK;
|
|
|
|
DEBUGASSERT(psock != NULL);
|
|
|
|
/* Draining depends on the socket family */
|
|
|
|
switch (psock->s_type)
|
|
{
|
|
#if defined(NET_TCP_HAVE_STACK) && defined(CONFIG_NET_TCP_WRITE_BUFFERS)
|
|
case SOCK_STREAM:
|
|
{
|
|
ret = tcp_txdrain(psock, abstime);
|
|
}
|
|
break;
|
|
#endif
|
|
|
|
#if defined(NET_UDP_HAVE_STACK) && defined(CONFIG_NET_UDP_WRITE_BUFFERS)
|
|
case SOCK_DGRAM:
|
|
{
|
|
ret = udp_txdrain(psock, abstime);
|
|
}
|
|
break;
|
|
#endif
|
|
|
|
/* Other protocols do no support write buffering */
|
|
|
|
default:
|
|
break;
|
|
}
|
|
|
|
return ret;
|
|
}
|