dlls/netapi32/nbcmdqueue.h

   1 /* Copyright (c) 2003 Juan Lang
   2  *
   3  * This library is free software; you can redistribute it and/or
   4  * modify it under the terms of the GNU Lesser General Public
   5  * License as published by the Free Software Foundation; either
   6  * version 2.1 of the License, or (at your option) any later version.
   7  *
   8  * This library is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11  * Lesser General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU Lesser General Public
  14  * License along with this library; if not, write to the Free Software
  15  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  16  */
  17 #ifndef __NBCMDQUEUE_H__
  18 #define __NBCMDQUEUE_H__
  19
  20 #include <stdarg.h>
  21 #include "windef.h"
  22 #include "winbase.h"
  23 #include "nb30.h"
  24
  25 /* This file defines a queue of pending NetBIOS commands.  The queue operations
  26  * are thread safe, with the exception of NBCmdQueueDestroy:  ensure no other
  27  * threads are manipulating the queue when calling NBCmdQueueDestroy.
  28  */
  29
  30 struct NBCmdQueue;
  31
  32 /* Allocates a new command queue from heap. */
  33 struct NBCmdQueue *NBCmdQueueCreate(HANDLE heap);
  34
  35 /* Adds ncb to queue.  Assumes queue is not NULL, and ncb is not already in the
  36  * queue.  If ncb is already in the queue, returns NRC_TOOMANY.
  37  */
  38 UCHAR NBCmdQueueAdd(struct NBCmdQueue *queue, PNCB ncb);
  39
  40 /* Cancels the given ncb.  Blocks until the command completes.  Implicitly
  41  * removes ncb from the queue.  Assumes queue and ncb are not NULL, and that
  42  * ncb has been added to queue previously.
  43  * Returns NRC_CMDCAN on a successful cancellation, NRC_CMDOCCR if the command
  44  * completed before it could be cancelled, and various other return values for
  45  * different failures.
  46  */
  47 UCHAR NBCmdQueueCancel(struct NBCmdQueue *queue, PNCB ncb);
  48
  49 /* Sets the return code of the given ncb, and implicitly removes the command
  50  * from the queue.  Assumes queue and ncb are not NULL, and that ncb has been
  51  * added to queue previously.
  52  * Returns NRC_GOODRET on success.
  53  */
  54 UCHAR NBCmdQueueComplete(struct NBCmdQueue *queue, PNCB ncb, UCHAR retcode);
  55
  56 /* Cancels all pending commands in the queue (useful for a RESET or a shutdown).
  57  * Returns when all commands have been completed.
  58  */
  59 UCHAR NBCmdQueueCancelAll(struct NBCmdQueue *queue);
  60
  61 /* Frees all memory associated with the queue.  Blocks until all commands
  62  * pending in the queue have been completed.
  63  */
  64 void NBCmdQueueDestroy(struct NBCmdQueue *queue);
  65
  66 #endif /* __NBCMDQUEUE_H__ */