X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/740d50812a81c59013f22888ab313da5a8113227..071079858329b6eaa616f1fc2c0b12a441973e17:/src/msg/msg_mailbox.h diff --git a/src/msg/msg_mailbox.h b/src/msg/msg_mailbox.h deleted file mode 100644 index 8a7953c7c8..0000000000 --- a/src/msg/msg_mailbox.h +++ /dev/null @@ -1,112 +0,0 @@ -/* Copyright (c) 2008-2015. The SimGrid Team. - * All rights reserved. */ - -/* This program is free software; you can redistribute it and/or modify it - * under the terms of the license (GNU LGPL) which comes with this package. */ - -#ifndef MSG_MAILBOX_H -#define MSG_MAILBOX_H - -#include -#include "xbt/fifo.h" -#include "simgrid/simix.h" -#include "simgrid/msg.h" - - -SG_BEGIN_DECL() -#define MAX_ALIAS_NAME ((size_t)260) - -/*! \brief MSG_mailbox_new - create a new mailbox. - * - * The function MSG_mailbox_new creates a new mailbox identified by the key specified - * by the parameter alias and add it in the global dictionary. - * - * \param alias The alias of the mailbox to create. - * - * \return The newly created mailbox. - */ -XBT_PUBLIC(msg_mailbox_t) - MSG_mailbox_new(const char *alias); - -XBT_PRIVATE void MSG_mailbox_free(void *mailbox); - -/* \brief MSG_mailbox_free - release a mailbox from the memory. - * - * The function MSG_mailbox_free release a mailbox from the memory but does - * not remove it from the dictionary. - * - * \param mailbox The mailbox to release. - * - * \see MSG_mailbox_destroy. - */ -XBT_PRIVATE void MSG_mailbox_free(void *mailbox); - -/* \brief MSG_mailbox_get_by_alias - get a mailbox from its alias. - * - * The function MSG_mailbox_get_by_alias returns the mailbox associated with - * the key specified by the parameter alias. If the mailbox does not exists, - * the function create it. - * - * \param alias The alias of the mailbox to return. - * - * \return The mailbox associated with the alias specified as parameter - * or a new mailbox if the key does not match. - */ -XBT_PUBLIC(msg_mailbox_t) - MSG_mailbox_get_by_alias(const char *alias); - -/*! \brief MSG_mailbox_is_empty - test if a mailbox is empty. - * - * The function MSG_mailbox_is_empty tests if a mailbox is empty - * (contains no msg task). - * - * \param mailbox The mailbox to get test. - * - * \return The function returns 1 if the mailbox is empty. Otherwise the function - * returns 0. - */ -XBT_PUBLIC(int) MSG_mailbox_is_empty(msg_mailbox_t mailbox); - -/* \brief MSG_mailbox_set_async - set a mailbox as eager - * - * The function MSG_mailbox_set_async sets the mailbox to a permanent receiver mode - * Messages sent to this mailbox will then be sent just after the send is issued, - * without waiting for the corresponding receive. - * - * This call should be done before issuing any receive, and on the receiver's side only - * - * \param alias The alias of the mailbox to modify. - * - */ -XBT_PUBLIC(void) MSG_mailbox_set_async(const char *alias); - -/*! \brief MSG_mailbox_get_head - get the task at the head of a mailbox. - * - * The MSG_mailbox_get_head returns the task at the head of the mailbox. - * This function does not remove the task from the mailbox (contrary to - * the function MSG_mailbox_pop_head). - * - * \param mailbox The mailbox concerned by the operation. - * - * \return The task at the head of the mailbox. - */ -XBT_PUBLIC(msg_task_t) - MSG_mailbox_get_head(msg_mailbox_t mailbox); - -/*! \brief MSG_mailbox_get_count_host_waiting_tasks - Return the number of tasks - waiting to be received in a mailbox and sent by a host. - * - * \param mailbox The mailbox concerned by the operation. - * \param host The msg host containing the processes that have sended the - * tasks. - * - * \return The number of tasks in the mailbox specified by the - * parameter mailbox and sended by all the processes located - * on the host specified by the parameter host. - */ -XBT_PUBLIC(int) -MSG_mailbox_get_count_host_waiting_tasks(msg_mailbox_t mailbox, - msg_host_t host); - -SG_END_DECL() -#endif /* !MSG_MAILBOX_H */