*nix Documentation Project
·  Home
 +   man pages
·  Linux HOWTOs
·  FreeBSD Tips
·  *niX Forums

  man pages->FreeBSD man pages -> sockatmark (3)              



NAME    [Toc]    [Back]

     sockatmark -- determine whether the read pointer is at the OOB mark

LIBRARY    [Toc]    [Back]

     Standard C Library (libc, -lc)

SYNOPSIS    [Toc]    [Back]

     #include <sys/socket.h>

     sockatmark(int s);

DESCRIPTION    [Toc]    [Back]

     To find out if the read pointer is currently pointing at the mark in the
     data stream, the sockatmark() function is provided.  If 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.

	   #include <sys/socket.h>
		   int out = FWRITE, mark;
		   char waste[BUFSIZ];

		   /* flush local terminal output */
		   ioctl(1, TIOCFLUSH, (char *)&out);
		   for (;;) {
			   if ((mark = sockatmark(rem)) < 0) {
			   if (mark)
			   (void) read(rem, waste, sizeof (waste));
		   if (recv(rem, &mark, 1, MSG_OOB) < 0) {

RETURN VALUES    [Toc]    [Back]

     Upon successful completion, the 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 errno is set to
     indicate the error.

ERRORS    [Toc]    [Back]

     The sockatmark() call fails if:

     [EBADF]		The s argument is not a valid descriptor.

     [ENOTTY]		The s argument is a descriptor for a file, not a

SEE ALSO    [Toc]    [Back]

     recv(2), send(2)

HISTORY    [Toc]    [Back]

     The sockatmark() function was introduced by IEEE Std 1003.1-2001
     (``POSIX.1''), to standardize the historical SIOCATMARK ioctl(2).	The
     ENOTTY error instead of the usual ENOTSOCK is to match the historical
     behavior of SIOCATMARK.

FreeBSD 5.2.1		       October 13, 2002 		 FreeBSD 5.2.1
[ Back ]
 Similar pages
Name OS Title
sockatmark NetBSD determine whether a socket is at the out-of-band mark
AFreadmisc IRIX read from / write to / move logical read/write pointer for data in a miscellaneous chunk in an audio file
CDseekblock IRIX set read pointer for CD-ROM to start of specified block
CDseektrack IRIX set read pointer for CD-ROM to start of specified track
lseek IRIX move read/write file pointer
RD Tru64 STREAMS: Gets a pointer to a module's read queue
tell IRIX return the read/write file pointer
CDseek IRIX set read pointer for CD-ROM to absolute time code location
lseek HP-UX move read/write file pointer; seek
afSaveFilePosition IRIX save and retrieve logical audio sample read pointer
Copyright © 2004-2005 DeniX Solutions SRL
newsletter delivery service