msgmod.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023 DomainTools LLC
 * Copyright (c) 2008-2015 by Farsight Security, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef NMSG_MSGMOD_H
#define NMSG_MSGMOD_H
 
typedef enum {
        nmsg_msgmod_ft_enum,
 
        nmsg_msgmod_ft_bytes,
 
        nmsg_msgmod_ft_string,
 
        nmsg_msgmod_ft_mlstring,
 
        nmsg_msgmod_ft_ip,
 
        nmsg_msgmod_ft_uint16,
 
        nmsg_msgmod_ft_uint32,
 
        nmsg_msgmod_ft_uint64,
 
        nmsg_msgmod_ft_int16,
 
        nmsg_msgmod_ft_int32,
 
        nmsg_msgmod_ft_int64,
 
        nmsg_msgmod_ft_double,
 
        nmsg_msgmod_ft_bool,
} nmsg_msgmod_field_type;
 
#define NMSG_MSGMOD_FIELD_REPEATED      0x01    /*%< field is repeated */
#define NMSG_MSGMOD_FIELD_REQUIRED      0x02    /*%< field is required */
#define NMSG_MSGMOD_FIELD_HIDDEN        0x04    /*%< hide field from the message API */
#define NMSG_MSGMOD_FIELD_NOPRINT       0x08    /*%< don't print the field */
#define NMSG_MSGMOD_FIELD_FORMAT_RAW    0x10    /*%< treat format return value as is */
 
nmsg_res
nmsg_msgmod_init(nmsg_msgmod_t mod, void **clos);
 
nmsg_res
nmsg_msgmod_fini(nmsg_msgmod_t mod, void **clos);
 
nmsg_res
nmsg_msgmod_pres_to_payload(nmsg_msgmod_t mod, void *clos, const char *pres);
 
nmsg_res
nmsg_msgmod_pres_to_payload_finalize(nmsg_msgmod_t mod, void *clos, uint8_t **pbuf,
                                     size_t *sz);
 
nmsg_res
nmsg_msgmod_ipdg_to_payload(nmsg_msgmod_t mod, void *clos,
                            const struct nmsg_ipdg *dg,
                            uint8_t **pbuf, size_t *sz);
 
nmsg_res
nmsg_msgmod_pkt_to_payload(struct nmsg_msgmod *mod, void *clos,
                           nmsg_pcap_t pcap, nmsg_message_t *m);
 
nmsg_msgmod_t
nmsg_msgmod_lookup(unsigned vid, unsigned msgtype);
 
nmsg_msgmod_t
nmsg_msgmod_lookup_byname(const char *vname, const char *mname);
 
unsigned
nmsg_msgmod_mname_to_msgtype(unsigned vid, const char *mname);
 
const char *
nmsg_msgmod_msgtype_to_mname(unsigned vid, unsigned msgtype);
 
const char *
nmsg_msgmod_vid_to_vname(unsigned vid);
 
unsigned
nmsg_msgmod_vname_to_vid(const char *vname);
 
unsigned
nmsg_msgmod_get_max_vid(void);
 
unsigned
nmsg_msgmod_get_max_msgtype(unsigned vid);
 
#endif /* NMSG_MSGMOD_H */