osmocom
/
libosmocore
mirror of https://gerrit.osmocom.org/libosmocore
11
0
Fork 1
Code Issues Releases Wiki Activity
libosmocore/include/osmocom/core/write_queue.h

82 lines
2.6 KiB
C
Raw Normal View History

[write_queue] Add a generic write queue class The write queue can be a dropin replacement for the bsc_fd. It is featuring two callbacks. One for ready read and one for ready write. Whenever there is a message in the queue the write_queue will set the BSC_FD_WRITE flag and then call the write callback. It will make sure to delete the msgb after the write function has been called. This class is intended to be be used in the osmocom, layer2, bsc_msc_ip, bsc_hack and other applications.
2010-02-26 19:30:32 +00:00
/* Generic write queue implementation */
/*
* (C) 2010 by Holger Hans Peter Freyther
* (C) 2010 by On-Waves
*
* All Rights Reserved
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
*/
write-queue: use namespace prefix osmo_wqueue* Summary of changes: s/struct write_queue/struct osmo_wqueue/g s/write_queue_init/osmo_wqueue_init/g s/void write_queue_clear/osmo_wqueue_clear/g s/write_queue_enqueue/osmo_wqueue_enqueue/g s/write_queue_bfd_cb/osmo_wqueue_bfd_cb/g
2011-05-07 10:42:51 +00:00
#ifndef OSMO_WQUEUE_H
#define OSMO_WQUEUE_H
[write_queue] Add a generic write queue class The write queue can be a dropin replacement for the bsc_fd. It is featuring two callbacks. One for ready read and one for ready write. Whenever there is a message in the queue the write_queue will set the BSC_FD_WRITE flag and then call the write callback. It will make sure to delete the msgb after the write function has been called. This class is intended to be be used in the osmocom, layer2, bsc_msc_ip, bsc_hack and other applications.
2010-02-26 19:30:32 +00:00
start to add doxygen documentation to libosmocore headers
2011-08-16 21:26:52 +00:00
/*! \file write_queue.h
* \brief Osmocom write queues
*/
write_queue: use full path of includes in osmocom/core/write_queue.h
2011-03-28 17:24:20 +00:00
#include <osmocom/core/select.h>
#include <osmocom/core/msgb.h>
[write_queue] Add a generic write queue class The write queue can be a dropin replacement for the bsc_fd. It is featuring two callbacks. One for ready read and one for ready write. Whenever there is a message in the queue the write_queue will set the BSC_FD_WRITE flag and then call the write callback. It will make sure to delete the msgb after the write function has been called. This class is intended to be be used in the osmocom, layer2, bsc_msc_ip, bsc_hack and other applications.
2010-02-26 19:30:32 +00:00
start to add doxygen documentation to libosmocore headers
2011-08-16 21:26:52 +00:00
/*! write queue instance */
write-queue: use namespace prefix osmo_wqueue* Summary of changes: s/struct write_queue/struct osmo_wqueue/g s/write_queue_init/osmo_wqueue_init/g s/void write_queue_clear/osmo_wqueue_clear/g s/write_queue_enqueue/osmo_wqueue_enqueue/g s/write_queue_bfd_cb/osmo_wqueue_bfd_cb/g
2011-05-07 10:42:51 +00:00
struct osmo_wqueue {
start to add doxygen documentation to libosmocore headers
2011-08-16 21:26:52 +00:00
/*! \brief osmocom file descriptor */
select: use namespace prefix osmo_fd* and osmo_select* Summary of changes: s/struct bsc_fd/struct osmo_fd/g s/bsc_register_fd/osmo_fd_register/g s/bsc_unregister_fd/osmo_fd_unregister/g s/bsc_select_main/osmo_select_main/g
2011-05-07 10:42:40 +00:00
struct osmo_fd bfd;
start to add doxygen documentation to libosmocore headers
2011-08-16 21:26:52 +00:00
/*! \brief maximum length of write queue */
[write_queue] Add a generic write queue class The write queue can be a dropin replacement for the bsc_fd. It is featuring two callbacks. One for ready read and one for ready write. Whenever there is a message in the queue the write_queue will set the BSC_FD_WRITE flag and then call the write callback. It will make sure to delete the msgb after the write function has been called. This class is intended to be be used in the osmocom, layer2, bsc_msc_ip, bsc_hack and other applications.
2010-02-26 19:30:32 +00:00
unsigned int max_length;
start to add doxygen documentation to libosmocore headers
2011-08-16 21:26:52 +00:00
/*! \brief current length of write queue */
[write_queue] Add a generic write queue class The write queue can be a dropin replacement for the bsc_fd. It is featuring two callbacks. One for ready read and one for ready write. Whenever there is a message in the queue the write_queue will set the BSC_FD_WRITE flag and then call the write callback. It will make sure to delete the msgb after the write function has been called. This class is intended to be be used in the osmocom, layer2, bsc_msc_ip, bsc_hack and other applications.
2010-02-26 19:30:32 +00:00
unsigned int current_length;
start to add doxygen documentation to libosmocore headers
2011-08-16 21:26:52 +00:00
/*! \brief actual linked list implementing the queue */
[write_queue] Add a generic write queue class The write queue can be a dropin replacement for the bsc_fd. It is featuring two callbacks. One for ready read and one for ready write. Whenever there is a message in the queue the write_queue will set the BSC_FD_WRITE flag and then call the write callback. It will make sure to delete the msgb after the write function has been called. This class is intended to be be used in the osmocom, layer2, bsc_msc_ip, bsc_hack and other applications.
2010-02-26 19:30:32 +00:00
struct llist_head msg_queue;
start to add doxygen documentation to libosmocore headers
2011-08-16 21:26:52 +00:00
/*! \brief call-back in case qeueue is readable */
select: use namespace prefix osmo_fd* and osmo_select* Summary of changes: s/struct bsc_fd/struct osmo_fd/g s/bsc_register_fd/osmo_fd_register/g s/bsc_unregister_fd/osmo_fd_unregister/g s/bsc_select_main/osmo_select_main/g
2011-05-07 10:42:40 +00:00
int (*read_cb)(struct osmo_fd *fd);
start to add doxygen documentation to libosmocore headers
2011-08-16 21:26:52 +00:00
/*! \brief call-back in case qeueue is writable */
select: use namespace prefix osmo_fd* and osmo_select* Summary of changes: s/struct bsc_fd/struct osmo_fd/g s/bsc_register_fd/osmo_fd_register/g s/bsc_unregister_fd/osmo_fd_unregister/g s/bsc_select_main/osmo_select_main/g
2011-05-07 10:42:40 +00:00
int (*write_cb)(struct osmo_fd *fd, struct msgb *msg);
start to add doxygen documentation to libosmocore headers
2011-08-16 21:26:52 +00:00
/*! \brief call-back in case qeueue has exceptions */
select: use namespace prefix osmo_fd* and osmo_select* Summary of changes: s/struct bsc_fd/struct osmo_fd/g s/bsc_register_fd/osmo_fd_register/g s/bsc_unregister_fd/osmo_fd_unregister/g s/bsc_select_main/osmo_select_main/g
2011-05-07 10:42:40 +00:00
int (*except_cb)(struct osmo_fd *fd);
[write_queue] Add a generic write queue class The write queue can be a dropin replacement for the bsc_fd. It is featuring two callbacks. One for ready read and one for ready write. Whenever there is a message in the queue the write_queue will set the BSC_FD_WRITE flag and then call the write callback. It will make sure to delete the msgb after the write function has been called. This class is intended to be be used in the osmocom, layer2, bsc_msc_ip, bsc_hack and other applications.
2010-02-26 19:30:32 +00:00
};
start to add doxygen documentation to libosmocore headers
2011-08-16 21:26:52 +00:00
/*! \brief Initialize a \ref osmo_wqueue structure
* \param[in] queue Write queue to operate on
* \param[in] max_length Maximum length of write queue
*/
write-queue: use namespace prefix osmo_wqueue* Summary of changes: s/struct write_queue/struct osmo_wqueue/g s/write_queue_init/osmo_wqueue_init/g s/void write_queue_clear/osmo_wqueue_clear/g s/write_queue_enqueue/osmo_wqueue_enqueue/g s/write_queue_bfd_cb/osmo_wqueue_bfd_cb/g
2011-05-07 10:42:51 +00:00
void osmo_wqueue_init(struct osmo_wqueue *queue, int max_length);
start to add doxygen documentation to libosmocore headers
2011-08-16 21:26:52 +00:00
/*! \brief Clear a \ref osmo_wqueue
* \param[in] queue Write queue to be cleared
*
* This function will clear (remove/release) all messages in it.
*/
write-queue: use namespace prefix osmo_wqueue* Summary of changes: s/struct write_queue/struct osmo_wqueue/g s/write_queue_init/osmo_wqueue_init/g s/void write_queue_clear/osmo_wqueue_clear/g s/write_queue_enqueue/osmo_wqueue_enqueue/g s/write_queue_bfd_cb/osmo_wqueue_bfd_cb/g
2011-05-07 10:42:51 +00:00
void osmo_wqueue_clear(struct osmo_wqueue *queue);
start to add doxygen documentation to libosmocore headers
2011-08-16 21:26:52 +00:00
/*! \brief Enqueue a new \ref msgb into a write queue
* \param[in] queue Write queue to be used
* \param[in] data to-be-enqueued message buffer
*/
write-queue: use namespace prefix osmo_wqueue* Summary of changes: s/struct write_queue/struct osmo_wqueue/g s/write_queue_init/osmo_wqueue_init/g s/void write_queue_clear/osmo_wqueue_clear/g s/write_queue_enqueue/osmo_wqueue_enqueue/g s/write_queue_bfd_cb/osmo_wqueue_bfd_cb/g
2011-05-07 10:42:51 +00:00
int osmo_wqueue_enqueue(struct osmo_wqueue *queue, struct msgb *data);
start to add doxygen documentation to libosmocore headers
2011-08-16 21:26:52 +00:00
/*! \brief Select loop function for write queue handling
* \param[in] fd osmocom file descriptor
* \param[in] what bit-mask of events that have happened
*
* This function is provided so that it can be registered with the
* select loop abstraction code (\ref osmo_fd::cb).
*/
write-queue: use namespace prefix osmo_wqueue* Summary of changes: s/struct write_queue/struct osmo_wqueue/g s/write_queue_init/osmo_wqueue_init/g s/void write_queue_clear/osmo_wqueue_clear/g s/write_queue_enqueue/osmo_wqueue_enqueue/g s/write_queue_bfd_cb/osmo_wqueue_bfd_cb/g
2011-05-07 10:42:51 +00:00
int osmo_wqueue_bfd_cb(struct osmo_fd *fd, unsigned int what);
[write_queue] Add a generic write queue class The write queue can be a dropin replacement for the bsc_fd. It is featuring two callbacks. One for ready read and one for ready write. Whenever there is a message in the queue the write_queue will set the BSC_FD_WRITE flag and then call the write callback. It will make sure to delete the msgb after the write function has been called. This class is intended to be be used in the osmocom, layer2, bsc_msc_ip, bsc_hack and other applications.
2010-02-26 19:30:32 +00:00
#endif