include/net/queue.h

   1 /*
   2  * Copyright (c) 2003-2008 Fabrice Bellard
   3  * Copyright (c) 2009 Red Hat, Inc.
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy
   6  * of this software and associated documentation files (the "Software"), to deal
   7  * in the Software without restriction, including without limitation the rights
   8  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   9  * copies of the Software, and to permit persons to whom the Software is
  10  * furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in
  13  * all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  21  * THE SOFTWARE.
  22  */
  23
  24 #ifndef QEMU_NET_QUEUE_H
  25 #define QEMU_NET_QUEUE_H
  26
  27 #include "qemu-common.h"
  28
  29 typedef struct NetPacket NetPacket;
  30 typedef struct NetQueue NetQueue;
  31
  32 typedef void (NetPacketSent) (NetClientState *sender, ssize_t ret);
  33
  34 #define QEMU_NET_PACKET_FLAG_NONE  0
  35 #define QEMU_NET_PACKET_FLAG_RAW  (1<<0)
  36
  37 /* Returns:
  38  *   >0 - success
  39  *    0 - queue packet for future redelivery
  40  *   <0 - failure (discard packet)
  41  */
  42 typedef ssize_t (NetQueueDeliverFunc)(NetClientState *sender,
  43                                       unsigned flags,
  44                                       const struct iovec *iov,
  45                                       int iovcnt,
  46                                       void *opaque);
  47
  48 NetQueue *qemu_new_net_queue(NetQueueDeliverFunc *deliver, void *opaque);
  49
  50 void qemu_net_queue_append_iov(NetQueue *queue,
  51                                NetClientState *sender,
  52                                unsigned flags,
  53                                const struct iovec *iov,
  54                                int iovcnt,
  55                                NetPacketSent *sent_cb);
  56
  57 void qemu_del_net_queue(NetQueue *queue);
  58
  59 ssize_t qemu_net_queue_send(NetQueue *queue,
  60                             NetClientState *sender,
  61                             unsigned flags,
  62                             const uint8_t *data,
  63                             size_t size,
  64                             NetPacketSent *sent_cb);
  65
  66 ssize_t qemu_net_queue_send_iov(NetQueue *queue,
  67                                 NetClientState *sender,
  68                                 unsigned flags,
  69                                 const struct iovec *iov,
  70                                 int iovcnt,
  71                                 NetPacketSent *sent_cb);
  72
  73 void qemu_net_queue_purge(NetQueue *queue, NetClientState *from);
  74 bool qemu_net_queue_flush(NetQueue *queue);
  75
  76 #endif /* QEMU_NET_QUEUE_H */