Changeset 1098:f38d77f9cfd3 in freeDiameter for include
- Timestamp:
- May 9, 2013, 12:59:34 PM (11 years ago)
- Branch:
- default
- Phase:
- public
- Location:
- include/freeDiameter
- Files:
-
- 3 edited
Legend:
- Unmodified
- Added
- Removed
-
include/freeDiameter/freeDiameter-host.h.in
r935 r1098 95 95 #endif /* FD_DEFAULT_CONF_FILENAME */ 96 96 97 /* Maximum number of hooks handlers that can be registered. Make this compilation option if needed */ 98 #define FD_HOOK_HANDLE_LIMIT 5 99 97 100 #ifdef __cplusplus 98 101 } -
include/freeDiameter/libfdcore.h
r1088 r1098 879 879 /* These functions allow an extension to collect state information about the 880 880 * framework, as well as being hooked at some key checkpoints in the processing 881 * for logging /statistics purpose.881 * for logging or statistics purpose. 882 882 */ 883 883 … … 887 887 * PARAMETERS: 888 888 * type : The type of hook that triggered this call, in case same cb is registered for several hooks. 889 * msg : If relevant, the pointer to the message trigg ing the call. NULL otherwise.889 * msg : If relevant, the pointer to the message triggering the call. NULL otherwise. 890 890 * peer : If relevant, the pointer to the peer associated with the call. NULL otherwise. 891 891 * other : For some callbacks, the remaining information is passed in this parameter. See each hook detail. 892 892 * permsgdata : Structure associated with a given message, across several hooks. 893 * Samestructure is associated with requests and corresponding answers.893 * A different structure is associated with requests and corresponding answers. 894 894 * See fd_hook_data_hdl below for details. 895 895 * If no fd_hook_data_hdl is registered with this callback, this parameter is always NULL … … 916 916 - {msg} is NULL. 917 917 - {peer} is NULL. 918 - {*other} is NULL, {other} points to a valid location where you can store a pointer. 919 This same pointer will then passed to the next hook, once message is processed. 920 IMPORTANT: free() will be called on this pointer if any problem, so this pointer must be malloc'd. 921 - {permsgdata} is NULL. 918 - {other} is a pointer to a structure { size_t len; uint8_t * buf; } containing the received buffer. 919 - {permsgdata} points to either a new empty structure allocated for this message (cf. fd_hook_data_hdl), or NULL if no hdl is registered. 922 920 */ 923 921 … … 928 926 - {peer} is set if the message is received from a peer's connection, and NULL if the message is from a new client 929 927 connected and not yet identified 930 - { *other} contains the pointer stored with the HOOK_DATA_RECEIVED hook if any, NULL otherwise. After this hook returns, free(*other) is called if notNULL.931 - {permsgdata} points to either a new empty structure allocated for this request (cf. fd_hook_data_hdl), or the request's existing structure if the message is an answer.928 - {other} is NULL. 929 - {permsgdata} points to either a new empty structure allocated for this message or the one passed to HOOK_DATA_RECEIVED if used. 932 930 */ 933 931 … … 946 944 try to call fd_msg_parse_dict, it will slow down the operation of a relay agent. 947 945 - {peer} is set if the message is sent to a peer's connection, and NULL if the message is sent to a new client 948 connected and not yet identified /being rejected946 connected and not yet identified, or being rejected 949 947 - {other} is NULL. 950 948 - {permsgdata} points to existing structure if any, or a new structure otherwise. 951 If the message is an answer, the structure is shared with the corresponding request.952 949 */ 953 950 … … 959 956 - {peer} is the peer this message was previously sent to. 960 957 - {other} is NULL. 961 - {permsgdata} points to existing structure associated with this request.958 - {permsgdata} points to existing structure if any, or a new structure otherwise. 962 959 */ 963 960 … … 994 991 995 992 HOOK_MESSAGE_DROPPED, 996 /* Hook called when a message is being discarded by the framework because of some error .997 It is probably a good idea to log this for analysis .993 /* Hook called when a message is being discarded by the framework because of some error condition (normal or abnormal). 994 It is probably a good idea to log this for analysis / backup. 998 995 - {msg} points to the message, which will be freed as soon as the hook returns. 999 996 - {peer} is NULL. … … 1022 1019 1023 1020 1024 /* Type if the {permsgdata} ointer. It is up to each extension to define its own structure. This is opaque for the framework. */1021 /* Type if the {permsgdata}. It is up to each extension to define its own structure. This is opaque for the framework. */ 1025 1022 struct fd_hook_permsgdata; 1026 1023 … … 1035 1032 * 1036 1033 * PARAMETERS: 1037 * permsgdata_new_cb : function called to initialize a new empty fd_hook_permsgdata structure, when a hook will be called for a message with not structure yet. If the function returns NULL, it will be called again for the next hook. 1038 * permsgdata_destroy_cb : function called when a message is being disposed. It should free the resources associated with the fd_hook_permsgdata. 1039 * new_handle : On success, a handler to the registered callback is stored here. 1034 * permsgdata_size : the size of the fd_hook_permsgdata structure. 1035 * permsgdata_init_cb : function called to initialize a new fd_hook_permsgdata structure, when a hook will be called for a message that does not have such structure yet. 1036 * The memory is already allocated and blanked, so you can pass NULL if no further handling is required. 1037 * permsgdata_fini_cb : function called when a message is being disposed. It should free the resources associated with the fd_hook_permsgdata. 1038 * You can pass NULL if no special handling is required. The memory of the permsgdata structure itself will be freed by the framework. 1039 * new_handle : On success, a handler to the registered callback is stored here. 1040 1040 * This handler will be used to unregister the cb. 1041 1041 * 1042 1042 * DESCRIPTION: 1043 1043 * Register a new fd_hook_data_hdl. This handle is used during hooks registration (see below) in order to associate data with the messages, to allow keeping tracking of the message easily. 1044 * Note that these handlers are statically allocated and cannot be unregistered. 1044 * Note that these handlers are statically allocated and cannot be unregistered. FD_HOOK_HANDLE_LIMIT handlers can be registered at maximum (recompile libfdproto if you change this value) 1045 1045 * 1046 1046 * RETURN VALUE: … … 1050 1050 */ 1051 1051 int fd_hook_data_register( 1052 struct fd_hook_permsgdata * (*permsgdata_new_cb) (void), 1053 void (*permsgdata_destroy_cb) (struct fd_hook_permsgdata *), 1054 struct fd_hook_data_hdl ** new_handle 1052 size_t permsgdata_size, 1053 void (*permsgdata_init_cb) (struct fd_hook_permsgdata *), 1054 void (*permsgdata_fini_cb) (struct fd_hook_permsgdata *), 1055 struct fd_hook_data_hdl **new_handle 1055 1056 ); 1056 1057 1057 1058 1058 /* A handler associated with a registered hook callback (for cleanup) */ … … 1063 1063 * 1064 1064 * PARAMETERS: 1065 * type : The fd_hook_type for which this cb is registered. Call several times if you want to register for several hooks.1065 * type_mask : A bitmask of fd_hook_type bits for which this cb is registered, e.g. ((1 << HOOK_MESSAGE_RECEIVED) || (1 << HOOK_MESSAGE_SENT)) 1066 1066 * fd_hook_cb : The callback function to register (see prototype above). 1067 1067 * regdata : Pointer to pass to the callback when it is called. The data is opaque to the daemon. … … 1079 1079 * ENOMEM : Not enough memory to complete the operation 1080 1080 */ 1081 int fd_hook_register ( enum fd_hook_type type,1082 void (*fd_hook_cb)(enum fd_hook_type type, struct msg * msg, struct peer_hdr * peer, void * other, void * regdata),1083 void *regdata,1081 int fd_hook_register ( uint32_t type_mask, 1082 void (*fd_hook_cb)(enum fd_hook_type type, struct msg * msg, struct peer_hdr * peer, void * other, struct fd_hook_permsgdata *pmd, void * regdata), 1083 void *regdata, 1084 1084 struct fd_hook_data_hdl *data_hdl, 1085 1085 struct fd_hook_hdl ** handler ); -
include/freeDiameter/libfdproto.h
r1097 r1098 2550 2550 2551 2551 2552 /* Helper for the hooks mechanism, for use from libfdcore */ 2553 struct fd_msg_pmdl { 2554 struct fd_list sentinel; /* if the sentinel.o field is NULL, the structure is not initialized. Otherwise it points to the cleanup function in libfdcore. */ 2555 pthread_mutex_t lock; 2556 }; 2557 #define FD_MSG_PMDL_INITIALIZER(pmdl_ptr) { FD_LIST_INITIALIZER( (pmdl_ptr)->sentinel ), PTHREAD_MUTEX_INITIALIZER } 2558 struct fd_msg_pmdl * fd_msg_pmdl_get(struct msg * msg); 2559 2552 2560 /***************************************/ 2553 2561 /* Manage AVP values */
Note: See TracChangeset
for help on using the changeset viewer.