remque(3)


NAME

   insque, remque - insert/remove an item from a queue

SYNOPSIS

   #include <search.h>

   void insque(void *elem, void *prev);

   void remque(void *elem);

   Feature Test Macro Requirements for glibc (see feature_test_macros(7)):

   insque(), remque():
       _XOPEN_SOURCE >= 500
           || /* Glibc since 2.19: */ _DEFAULT_SOURCE
           || /* Glibc versions <= 2.19: */ _SVID_SOURCE

DESCRIPTION

   The  insque()  and  remque()  functions manipulate doubly-linked lists.
   Each element in the list is a structure of which the first two elements
   are  a  forward  and a backward pointer.  The linked list may be linear
   (i.e., NULL forward pointer at the end of the list  and  NULL  backward
   pointer at the start of the list) or circular.

   The   insque()   function  inserts  the  element  pointed  to  by  elem
   immediately after the element pointed to by prev.

   If the list is linear, then the call insque(elem, NULL) can be used  to
   insert  the  initial  list  element,  and the call sets the forward and
   backward pointers of elem to NULL.

   If the list is circular, the caller should ensure that the forward  and
   backward pointers of the first element are initialized to point to that
   element, and the prev argument of the insque() call should  also  point
   to the element.

   The  remque()  function removes the element pointed to by elem from the
   doubly-linked list.

ATTRIBUTES

   For  an  explanation  of  the  terms  used   in   this   section,   see
   attributes(7).

   ┌───────────────────┬───────────────┬─────────┐
   │InterfaceAttributeValue   │
   ├───────────────────┼───────────────┼─────────┤
   │insque(), remque() │ Thread safety │ MT-Safe │
   └───────────────────┴───────────────┴─────────┘

CONFORMING TO

   POSIX.1-2001, POSIX.1-2008.

NOTES

   On  ancient  systems,  the  arguments  of  these functions were of type
   struct qelem *, defined as:

       struct qelem {
           struct qelem *q_forw;
           struct qelem *q_back;
           char          q_data[1];
       };

   This is still what you  will  get  if  _GNU_SOURCE  is  defined  before
   including <search.h>.

   The  location  of  the  prototypes  for  these  functions differs among
   several versions of UNIX.   The  above  is  the  POSIX  version.   Some
   systems place them in <string.h>.

BUGS

   In  glibc 2.4 and earlier, it was not possible to specify prev as NULL.
   Consequently, to build a linear list, the caller had to  build  a  list
   using  an  initial  call  that  contained the first two elements of the
   list, with the forward and backward pointers in each  element  suitably
   initialized.

EXAMPLE

   The program below demonstrates the use of insque().  Here is an example
   run of the program:

       $ ./a.out -c a b c
       Traversing completed list:
           a
           b
           c
       That was a circular list

   Program source

   #include <stdio.h>
   #include <stdlib.h>
   #include <unistd.h>
   #include <search.h>

   struct element {
       struct element *forward;
       struct element *backward;
       char *name;
   };

   static struct element *
   new_element(void)
   {
       struct element *e;

       e = malloc(sizeof(struct element));
       if (e == NULL) {
           fprintf(stderr, "malloc() failed\n");
           exit(EXIT_FAILURE);
       }

       return e;
   }

   int
   main(int argc, char *argv[])
   {
       struct element *first, *elem, *prev;
       int circular, opt, errfnd;

       /* The "-c" command-line option can be used to specify that the
          list is circular */

       errfnd = 0;
       circular = 0;
       while ((opt = getopt(argc, argv, "c")) != -1) {
           switch (opt) {
           case 'c':
               circular = 1;
               break;
           default:
               errfnd = 1;
               break;
           }
       }

       if (errfnd || optind >= argc) {
           fprintf(stderr,  "Usage: %s [-c] string...\n", argv[0]);
           exit(EXIT_FAILURE);
       }

       /* Create first element and place it in the linked list */

       elem = new_element();
       first = elem;

       elem->name = argv[optind];

       if (circular) {
           elem->forward = elem;
           elem->backward = elem;
           insque(elem, elem);
       } else {
           insque(elem, NULL);
       }

       /* Add remaining command-line arguments as list elements */

       while (++optind < argc) {
           prev = elem;

           elem = new_element();
           elem->name = argv[optind];
           insque(elem, prev);
       }

       /* Traverse the list from the start, printing element names */

       printf("Traversing completed list:\n");
       elem = first;
       do {
           printf("    %s\n", elem->name);
           elem = elem->forward;
       } while (elem != NULL && elem != first);

       if (elem == first)
           printf("That was a circular list\n");

       exit(EXIT_SUCCESS);
   }

COLOPHON

   This page is part of release 4.09 of the Linux  man-pages  project.   A
   description  of  the project, information about reporting bugs, and the
   latest    version    of    this    page,    can     be     found     at
   https://www.kernel.org/doc/man-pages/.

                              2016-12-12                         INSQUE(3)


More Linux Commands

manpages/XrmPutResource.3.html
XrmPutResource(3) - store database resources (Man Page).....
If database contains NULL, XrmPutResource creates a new database and returns a pointer to it. XrmPutResource is a convenience function that calls XrmStringToBin

manpages/ntdbbackup.8.html
ntdbbackup(8) tool for backing up and for validating the int
This tool is part of the samba(1) suite. ntdbbackup is a tool that may be used to backup samba .ntdb files. This tool may also be used to verify the integrity o

manpages/Tcl_ValidateAllMemory.3.html
Tcl_ValidateAllMemory(3) - Validated memory allocation inter
These functions provide access to Tcl memory debugging information. They are only functional when Tcl has been compiled with TCL_MEM_DEBUG defined at compile-ti

manpages/ldap_syntax2name.3.html
ldap_syntax2name(3) - Schema definition handling routines...
These routines are used to parse schema definitions in the syntax defined in RFC 4512 into structs and handle these structs. These routines handle four kinds of

manpages/XSetWMClientMachine.3.html
XSetWMClientMachine(3) - set or read a window's WM_CLIENT_MA
The XSetWMClientMachine convenience function calls XSetTextProperty to set the WM_CLIENT_MACHINE property. The XGetWMClientMachine convenience function performs

manpages/sha384.1ssl.html
sha384(1ssl) message digests (Commands - Linux man page)....
The digest functions output the message digest of a supplied file or files in hexadecimal. The digest functions also generate and verify digital signatures usin

manpages/pam_winbind.8.html
pam_winbind(8) - PAM module for Winbind - Linux manual page
This tool is part of the samba(7) suite. pam_winbind is a PAM module that can authenticate users against the local domain by talking to the Winbind daemon. SYNO

manpages/set_form_term.3form.html
set_form_term(3form) - set hooks for automatic invocation by
These functions make it possible to set hook functions to be called at various points in the automatic processing of input event codes by form_driver. The funct

manpages/perlebcdic.1.html
perlebcdic(1) - Considerations for running Perl on EBCDIC pl
An exploration of some of the issues facing Perl programmers on EBCDIC based computers. We do not cover localization, internationalization, or multi-byte charac

manpages/TIFFSetDirectory.3tiff.html
TIFFSetDirectory(3tiff) - set the current directory for an o
TIFFSetDirectory changes the current directory and reads its contents with TIFFReadDirectory. The parameter dirnum specifies the subfile/directory as an integer

manpages/patch.1.html
patch(1) - apply a diff file to an original - Linux man page
patch takes a patch file patchfile containing a difference listing produced by the diff program and applies those differences to one or more original files, pro

manpages/getutxid.3.html
getutxid(3) - access utmp file entries - Linux manual page
New applications should use the POSIX.1-specified utmpx versions of these functions; see CONFORMING TO. utmpname() sets the name of the utmp-format file for the





We can't live, work or learn in freedom unless the software we use is free.