nbcmdqueue.h 2.63 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14
/* Copyright (c) 2003 Juan Lang
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * 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 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
 */
#ifndef __NBCMDQUEUE_H__
#define __NBCMDQUEUE_H__

#include <stdarg.h>
#include "windef.h"
#include "winbase.h"
#include "nb30.h"

/* This file defines a queue of pending NetBIOS commands.  The queue operations
 * are thread safe, with the exception of NBCmdQueueDestroy:  ensure no other
 * threads are manipulating the queue when calling NBCmdQueueDestroy.
 */

struct NBCmdQueue;

/* Allocates a new command queue from heap. */
33
struct NBCmdQueue *NBCmdQueueCreate(HANDLE heap) DECLSPEC_HIDDEN;
34 35 36 37

/* Adds ncb to queue.  Assumes queue is not NULL, and ncb is not already in the
 * queue.  If ncb is already in the queue, returns NRC_TOOMANY.
 */
38
UCHAR NBCmdQueueAdd(struct NBCmdQueue *queue, PNCB ncb) DECLSPEC_HIDDEN;
39 40 41 42 43 44 45 46

/* Cancels the given ncb.  Blocks until the command completes.  Implicitly
 * removes ncb from the queue.  Assumes queue and ncb are not NULL, and that
 * ncb has been added to queue previously.
 * Returns NRC_CMDCAN on a successful cancellation, NRC_CMDOCCR if the command
 * completed before it could be cancelled, and various other return values for
 * different failures.
 */
47
UCHAR NBCmdQueueCancel(struct NBCmdQueue *queue, PNCB ncb) DECLSPEC_HIDDEN;
48 49 50 51 52 53

/* Sets the return code of the given ncb, and implicitly removes the command
 * from the queue.  Assumes queue and ncb are not NULL, and that ncb has been
 * added to queue previously.
 * Returns NRC_GOODRET on success.
 */
54
UCHAR NBCmdQueueComplete(struct NBCmdQueue *queue, PNCB ncb, UCHAR retcode) DECLSPEC_HIDDEN;
55 56 57 58

/* Cancels all pending commands in the queue (useful for a RESET or a shutdown).
 * Returns when all commands have been completed.
 */
59
UCHAR NBCmdQueueCancelAll(struct NBCmdQueue *queue) DECLSPEC_HIDDEN;
60 61 62 63

/* Frees all memory associated with the queue.  Blocks until all commands
 * pending in the queue have been completed.
 */
64
void NBCmdQueueDestroy(struct NBCmdQueue *queue) DECLSPEC_HIDDEN;
65 66

#endif /* __NBCMDQUEUE_H__ */