1 /* Copyright (c) 2008, 2009, 2010. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
11 #include "simix/simix.h"
12 #include "msg/datatypes.h"
16 #define MAX_ALIAS_NAME ((size_t)260)
18 /*! \brief MSG_mailbox_new - create a new mailbox.
20 * The function MSG_mailbox_new creates a new mailbox identified by the key specified
21 * by the parameter alias and add it in the global dictionary.
23 * \param alias The alias of the mailbox to create.
25 * \return The newly created mailbox.
27 XBT_PUBLIC(msg_mailbox_t)
28 MSG_mailbox_new(const char *alias);
30 /* \brief MSG_mailbox_free - release a mailbox from the memory.
32 * The function MSG_mailbox_free release a mailbox from the memory but does
33 * not remove it from the dictionary.
35 * \param mailbox The mailbox to release.
37 * \see MSG_mailbox_destroy.
39 void MSG_mailbox_free(void *mailbox);
41 /* \brief MSG_mailbox_get_by_alias - get a mailbox from its alias.
43 * The function MSG_mailbox_get_by_alias returns the mailbox associated with
44 * the key specified by the parameter alias. If the mailbox does not exists,
45 * the function create it.
47 * \param alias The alias of the mailbox to return.
49 * \return The mailbox associated with the alias specified as parameter
50 * or a new mailbox if the key does not match.
52 XBT_PUBLIC(msg_mailbox_t)
53 MSG_mailbox_get_by_alias(const char *alias);
55 /*! \brief MSG_mailbox_is_empty - test if a mailbox is empty.
57 * The function MSG_mailbox_is_empty tests if a mailbox is empty
58 * (contains no msg task).
60 * \param mailbox The mailbox to get test.
62 * \return The function returns 1 if the mailbox is empty. Otherwise the function
65 XBT_PUBLIC(int) MSG_mailbox_is_empty(msg_mailbox_t mailbox);
67 /*! \brief MSG_mailbox_get_head - get the task at the head of a mailbox.
69 * The MSG_mailbox_get_head returns the task at the head of the mailbox.
70 * This function does not remove the task from the mailbox (contrary to
71 * the function MSG_mailbox_pop_head).
73 * \param mailbox The mailbox concerned by the operation.
75 * \return The task at the head of the mailbox.
78 MSG_mailbox_get_head(msg_mailbox_t mailbox);
80 /*! \brief MSG_mailbox_get_count_host_waiting_tasks - Return the number of tasks
81 waiting to be received in a mailbox and sent by a host.
83 * \param mailbox The mailbox concerned by the operation.
84 * \param host The msg host containing the processes that have sended the
87 * \return The number of tasks in the mailbox specified by the
88 * parameter mailbox and sended by all the processes located
89 * on the host specified by the parameter host.
92 MSG_mailbox_get_count_host_waiting_tasks(msg_mailbox_t mailbox,
95 #ifdef MSG_USE_DEPRECATED
96 /* \brief MSG_mailbox_get_by_channel - get a mailbox of the specified host from its channel.
98 * The function MSG_mailbox_get_by_channel returns the mailbox of the
99 * specified host from the channel specified by the parameter
100 * channel. If the mailbox does not exists, the function fails.
102 * \param host The host containing he mailbox to get.
103 * \param channel The channel used to identify the mailbox.
105 * \return The mailbox of the specified host associated the channel
106 * specified as parameter.
109 XBT_PUBLIC(msg_mailbox_t)
110 MSG_mailbox_get_by_channel(m_host_t host, m_channel_t channel);
114 #endif /* !SMX_MAILBOX_H */