2 * @file frescan_bwres_requests.h
4 * @brief FRESCAN bandwith reservation layer: requests
6 * This module contains the request type definition and queues. They are used
7 * to ask negotiation, renegotiation or cancel contracts.
13 * @author Daniel Sangorrin <daniel.sangorrin@unican.es>
17 #ifndef _FRESCAN_BWRES_REQUESTS_H_
18 #define _FRESCAN_BWRES_REQUESTS_H_
21 #include "frescan_data.h" // frescan_contract_t
22 #include "frescan_bwres_robjs.h" // frescan_robj_id_t
25 * frescan_request_data_t
27 * This are the data contained in a request to perform the negotiation of
30 * @type: indicates the type of the request
31 * @contract: a pointer to the contract to (re)negotiate
32 * @ss: the local sporadic server ID
33 * @request_node: the node that performed the request
34 * @req: the request id of the SLAVE to identify the request in the reply
35 * @return_value: the value returned in a Reply
36 * @robj: a reply object to wait until a negotiation is completed
40 typedef uint16_t frescan_request_id_t; /* 0 .. MX_REQUESTS */
43 FRESCAN_REQ_NEG = 0, // Negotiate a contract
44 FRESCAN_REQ_RENEG = 1, // Renegotiate a contract
45 FRESCAN_REQ_CANCEL = 2, // Cancel a contract
46 FRESCAN_REP_NEG = 3, // Reply to (Re)Negotiate a contract
47 } frescan_request_type_t;
50 FRESCAN_REQ_ACCEPTED = 0, // the (re)negotiation is accepted
51 FRESCAN_REQ_NOT_ACCEPTED = 1, // the (re)negotiation is not accepted
52 FRESCAN_REQ_ERROR = 2, // error during the (re)negotiation
53 } frescan_request_retval_t;
56 frescan_request_type_t type;
57 frescan_contract_t *contract;
59 frescan_node_t request_node;
60 frescan_request_id_t req;
61 frescan_request_retval_t return_value;
62 frescan_robj_id_t robj;
63 } frescan_request_data_t;
66 * frescan_requests_init() - initializes the requests
68 * This function must be called at initialization time, before the rest of
69 * functions of this module.
71 * @max_ceiling: the max priority of the threads using this module
74 extern int frescan_requests_init(int max_ceiling);
77 * frescan_requests_alloc() - allocates a request
80 extern int frescan_requests_alloc(frescan_request_id_t *req);
83 * frescan_requests_free() - frees a request
86 extern int frescan_requests_free(frescan_request_id_t req);
89 * frescan_requests_get_data() - gets the data of the request
91 * @data: the data is obtained as a pointer an manipulated directly
92 * accesing to the members of the structure. Note that this is
93 * just an internal API so instead of using get/set functions we
94 * will just access to the members of the struc directly
97 extern int frescan_requests_get_data(frescan_request_id_t req,
98 frescan_request_data_t **data);
101 * frescan_requests_enqueue() - enqueue a request
104 extern int frescan_requests_enqueue(frescan_request_id_t req);
107 * frescan_requests_dequeue() - dequeue a request
110 extern int frescan_requests_dequeue(frescan_request_id_t *req);
112 #endif // _FRESCAN_BWRES_REQUESTS_H_