Add an implementation of the POSIX.1 sockatmark(3).
This commit is contained in:
Bill Fenner
parent
cc0163a3c4
commit
43ac5a2340
Notes:
svn2git
2020-12-20 02:59:44 +00:00
svn path=/head/; revision=107836
@ -19,7 +19,7 @@ SRCS+= addr2ascii.c ascii2addr.c base64.c ether_addr.c getaddrinfo.c \
|
||||
nsdispatch.c nslexer.c nsparser.c \
|
||||
nsap_addr.c rcmd.c rcmdsh.c recv.c res_comp.c res_data.c res_debug.c \
|
||||
res_init.c res_mkquery.c res_mkupdate.c res_query.c res_send.c \
|
||||
res_update.c rthdr.c send.c vars.c
|
||||
res_update.c rthdr.c send.c sockatmark.c vars.c
|
||||
# not supported: iso_addr.c
|
||||
|
||||
CFLAGS+=-DINET6 -I${.OBJDIR}
|
||||
@ -47,7 +47,7 @@ MAN+= addr2ascii.3 byteorder.3 ethers.3 getaddrinfo.3 gethostbyname.3 \
|
||||
if_indextoname.3 \
|
||||
inet.3 inet_net.3 \
|
||||
inet6_option_space.3 inet6_rthdr_space.3 linkaddr.3 \
|
||||
nsdispatch.3 rcmd.3 rcmdsh.3 resolver.3
|
||||
nsdispatch.3 rcmd.3 rcmdsh.3 resolver.3 sockatmark.3
|
||||
# not installed: iso_addr.3 ns.3
|
||||
|
||||
MLINKS+=addr2ascii.3 ascii2addr.3
|
||||
|
||||
114
lib/libc/net/sockatmark.3
Normal file
114
lib/libc/net/sockatmark.3
Normal file
@ -0,0 +1,114 @@
|
||||
.\" Copyright (c) 2002 William C. Fenner. All rights reserved.
|
||||
.\"
|
||||
.\" 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.
|
||||
.\"
|
||||
.\" THIS SOFTWARE IS PROVIDED BY THE 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 REGENTS 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.
|
||||
.\"
|
||||
.\" $FreeBSD$
|
||||
.\"
|
||||
.Dd October 13, 2002
|
||||
.Dt SOCKATMARK 3
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm sockatmark
|
||||
.Nd determine whether the read pointer is at the OOB mark
|
||||
.Sh LIBRARY
|
||||
.Lb libc
|
||||
.Sh SYNOPSIS
|
||||
.In sys/socket.h
|
||||
.Ft int
|
||||
.Fn sockatmark "int s"
|
||||
.Sh DESCRIPTION
|
||||
To find out if the read pointer is currently pointing at
|
||||
the mark in the data stream, the
|
||||
.Fn sockatmark
|
||||
function is provided. If
|
||||
.Fn sockatmark
|
||||
returns 1, the next read will return data
|
||||
after the mark. Otherwise (assuming out of band data has arrived),
|
||||
the next read will provide data sent by the client prior
|
||||
to transmission of the out of band signal. The routine used
|
||||
in the remote login process to flush output on receipt of an
|
||||
interrupt or quit signal is shown below.
|
||||
It reads the normal data up to the mark (to discard it),
|
||||
then reads the out-of-band byte.
|
||||
.Bd -literal -offset indent
|
||||
#include <sys/socket.h>
|
||||
...
|
||||
oob()
|
||||
{
|
||||
int out = FWRITE, mark;
|
||||
char waste[BUFSIZ];
|
||||
|
||||
/* flush local terminal output */
|
||||
ioctl(1, TIOCFLUSH, (char *)&out);
|
||||
for (;;) {
|
||||
if ((mark = sockatmark(rem)) < 0) {
|
||||
perror("sockatmark");
|
||||
break;
|
||||
}
|
||||
if (mark)
|
||||
break;
|
||||
(void) read(rem, waste, sizeof (waste));
|
||||
}
|
||||
if (recv(rem, &mark, 1, MSG_OOB) < 0) {
|
||||
perror("recv");
|
||||
...
|
||||
}
|
||||
...
|
||||
}
|
||||
.Ed
|
||||
.Sh RETURN VALUES
|
||||
Upon successful completion, the
|
||||
.Fn sockatmark
|
||||
function returns the value 1 if the read pointer is pointing at
|
||||
the OOB mark, 0 if it is not. Otherwise the value\~-1 is returned
|
||||
and the global variable \*[Va-font]errno\f[P] is set to
|
||||
indicate the error.
|
||||
.\" partly copied from .Rv
|
||||
.Sh ERRORS
|
||||
The
|
||||
.Fn sockatmark
|
||||
call fails if:
|
||||
.Bl -tag -width Er
|
||||
.It Bq Er EBADF
|
||||
.Fa s
|
||||
is not a valid descriptor.
|
||||
.It Bq Er ENOTTY
|
||||
.Fa s
|
||||
is a descriptor for a file, not a socket.
|
||||
.El
|
||||
.Sh SEE ALSO
|
||||
.Xr send 2 ,
|
||||
.Xr recv 2
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Fn sockatmark
|
||||
function call was introduced by
|
||||
.St -p1003.1-2001 ,
|
||||
to standardize the historical
|
||||
.Dv SIOCATMARK
|
||||
.Fn ioctl .
|
||||
The
|
||||
.Er ENOTTY
|
||||
error instead of the usual
|
||||
.Er ENOTSOCK
|
||||
is to match the historical behavior of
|
||||
.Dv SIOCATMARK .
|
||||
36
lib/libc/net/sockatmark.c
Normal file
36
lib/libc/net/sockatmark.c
Normal file
@ -0,0 +1,36 @@
|
||||
/*
|
||||
* Copyright (c) 2002 William C. Fenner. All rights reserved.
|
||||
*
|
||||
* 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.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY THE 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 REGENTS 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.
|
||||
*
|
||||
* $FreeBSD$
|
||||
*/
|
||||
#include <sys/ioctl.h>
|
||||
|
||||
int sockatmark(int s)
|
||||
{
|
||||
int atmark;
|
||||
|
||||
if (ioctl(s, SIOCATMARK, &atmark) == -1)
|
||||
return -1;
|
||||
return atmark;
|
||||
}
|
||||
Loading…
Reference in New Issue
Block a user