blob: b094fd99cbb81329f11ac3ff3ec8d3c84b77a598 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
|
/**
* @file IxNpeMhSolicitedCbMgr_p.h
*
* @author Intel Corporation
* @date 18 Jan 2002
*
* @brief This file contains the private API for the Solicited Callback
* Manager module.
*
*
* @par
* IXP400 SW Release version 2.0
*
* -- Copyright Notice --
*
* @par
* Copyright 2001-2005, Intel Corporation.
* All rights reserved.
*
* @par
* SPDX-License-Identifier: BSD-3-Clause
* @par
* -- End of Copyright Notice --
*/
/**
* @defgroup IxNpeMhSolicitedCbMgr_p IxNpeMhSolicitedCbMgr_p
*
* @brief The private API for the Solicited Callback Manager module.
*
* @{
*/
#ifndef IXNPEMHSOLICITEDCBMGR_P_H
#define IXNPEMHSOLICITEDCBMGR_P_H
#include "IxNpeMh.h"
#include "IxOsalTypes.h"
/*
* #defines for function return types, etc.
*/
/** Maximum number of solicited callbacks that can be stored in the list */
#define IX_NPEMH_MAX_CALLBACKS (16)
/*
* Prototypes for interface functions.
*/
/**
* @fn void ixNpeMhSolicitedCbMgrInitialize (void)
*
* @brief This function initializes the Solicited Callback Manager module,
* setting up a callback data structure for each NPE.
*
* @return No return value.
*/
void ixNpeMhSolicitedCbMgrInitialize (void);
/**
* @fn IX_STATUS ixNpeMhSolicitedCbMgrCallbackSave (
IxNpeMhNpeId npeId,
IxNpeMhMessageId solicitedMessageId,
IxNpeMhCallback solicitedCallback)
*
* @brief This function saves a callback in the specified NPE's callback
* list. If the callback list is full the function will fail.
*
* @param IxNpeMhNpeId npeId (in) - The ID of the NPE in whose callback
* list the callback will be saved.
* @param IxNpeMhMessageId solicitedMessageId (in) - The ID of the message
* that this callback is for.
* @param IxNpeMhCallback solicitedCallback (in) - The callback function
* pointer to save.
*
* @return The function returns a status indicating success or failure.
*/
IX_STATUS ixNpeMhSolicitedCbMgrCallbackSave (
IxNpeMhNpeId npeId,
IxNpeMhMessageId solicitedMessageId,
IxNpeMhCallback solicitedCallback);
/**
* @fn void ixNpeMhSolicitedCbMgrCallbackRetrieve (
IxNpeMhNpeId npeId,
IxNpeMhMessageId solicitedMessageId,
IxNpeMhCallback *solicitedCallback)
*
* @brief This function retrieves the first ID-matching callback from the
* specified NPE's callback list. If no matching callback can be found the
* function will fail.
*
* @param IxNpeMhNpeId npeId (in) - The ID of the NPE from whose callback
* list the callback will be retrieved.
* @param IxNpeMhMessageId solicitedMessageId (in) - The ID of the message
* that the callback is for.
* @param IxNpeMhCallback solicitedCallback (out) - The callback function
* pointer retrieved.
*
* @return No return value.
*/
void ixNpeMhSolicitedCbMgrCallbackRetrieve (
IxNpeMhNpeId npeId,
IxNpeMhMessageId solicitedMessageId,
IxNpeMhCallback *solicitedCallback);
/**
* @fn void ixNpeMhSolicitedCbMgrShow (
IxNpeMhNpeId npeId)
*
* @brief This function will display the current state of the Solicited
* Callback Manager module.
*
* @param IxNpeMhNpeId npeId (in) - The ID of the NPE to display state
* information for.
*
* @return No return value.
*/
void ixNpeMhSolicitedCbMgrShow (
IxNpeMhNpeId npeId);
/**
* @fn void ixNpeMhSolicitedCbMgrShowReset (
IxNpeMhNpeId npeId)
*
* @brief This function will reset the current state of the Solicited
* Callback Manager module.
*
* @param IxNpeMhNpeId npeId (in) - The ID of the NPE to reset state
* information for.
*
* @return No return value.
*/
void ixNpeMhSolicitedCbMgrShowReset (
IxNpeMhNpeId npeId);
#endif /* IXNPEMHSOLICITEDCBMGR_P_H */
/**
* @} defgroup IxNpeMhSolicitedCbMgr_p
*/
|
