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_create - create a new mailbox.
32 * The function MSG_mailbox_new creates a new mailbox identified by
33 * the key specified by the parameter alias and add it in the global
34 * dictionary but doesn't add it in the global dictionary. Typicaly,
35 * this type of mailbox is associated with a channel.
37 * \param alias The alias of the mailbox to create.
39 * \return The newly created mailbox.
41 msg_mailbox_t MSG_mailbox_create(const char *alias);
43 /* \brief MSG_mailbox_free - release a mailbox from the memory.
45 * The function MSG_mailbox_free release a mailbox from the memory but does
46 * not remove it from the dictionary.
48 * \param mailbox The mailbox to release.
50 * \see MSG_mailbox_destroy.
52 void MSG_mailbox_free(void *mailbox);
54 /* \brief MSG_mailbox_get_by_alias - get a mailbox from its alias.
56 * The function MSG_mailbox_get_by_alias returns the mailbox associated with
57 * the key specified by the parameter alias. If the mailbox does not exists,
58 * the function create it.
60 * \param alias The alias of the mailbox to return.
62 * \return The mailbox associated with the alias specified as parameter
63 * or a new mailbox if the key does not match.
65 XBT_PUBLIC(msg_mailbox_t)
66 MSG_mailbox_get_by_alias(const char *alias);
68 /* \brief MSG_mailbox_get_by_channel - get a mailbox of the specified host from its channel.
70 * The function MSG_mailbox_get_by_channel returns the mailbox of the
71 * specified host from the channel specified by the parameter
72 * channel. If the mailbox does not exists, the function fails.
74 * \param host The host containing he mailbox to get.
75 * \param channel The channel used to identify the mailbox.
77 * \return The mailbox of the specified host associated the channel
78 * specified as parameter.
81 XBT_PUBLIC(msg_mailbox_t)
82 MSG_mailbox_get_by_channel(m_host_t host, m_channel_t channel);
84 /*! \brief MSG_mailbox_is_empty - test if a mailbox is empty.
86 * The function MSG_mailbox_is_empty tests if a mailbox is empty
87 * (contains no msg task).
89 * \param mailbox The mailbox to get test.
91 * \return The function returns 1 if the mailbox is empty. Otherwise the function
94 XBT_PUBLIC(int) MSG_mailbox_is_empty(msg_mailbox_t mailbox);
96 /*! \brief MSG_mailbox_get_head - get the task at the head of a mailbox.
98 * The MSG_mailbox_get_head returns the task at the head of the mailbox.
99 * This function does not remove the task from the mailbox (contrary to
100 * the function MSG_mailbox_pop_head).
102 * \param mailbox The mailbox concerned by the operation.
104 * \return The task at the head of the mailbox.
107 MSG_mailbox_get_head(msg_mailbox_t mailbox);
109 /*! \brief MSG_mailbox_get_count_host_waiting_tasks - Return the number of tasks
110 waiting to be received in a mailbox and sent by a host.
112 * \param mailbox The mailbox concerned by the operation.
113 * \param host The msg host containing the processes that have sended the
116 * \return The number of tasks in the mailbox specified by the
117 * parameter mailbox and sended by all the processes located
118 * on the host specified by the parameter host.
121 MSG_mailbox_get_count_host_waiting_tasks(msg_mailbox_t mailbox,
126 #endif /* !SMX_MAILBOX_H */