message.h

Go to the documentation of this file.

/*
 * Copyright (c) 2009-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_MESSAGE_H
#define NMSG_MESSAGE_H
 
#include <nmsg/msgmod.h>
 
nmsg_message_t
nmsg_message_init(nmsg_msgmod_t mod);
 
nmsg_message_t
nmsg_message_from_raw_payload(unsigned vid, unsigned msgtype,
                              uint8_t *data, size_t sz,
                              const struct timespec *ts);
 
nmsg_res
nmsg_message_from_json(const char *json, nmsg_message_t *msg);
 
void
nmsg_message_destroy(nmsg_message_t *msg);
 
nmsg_res
nmsg_message_to_pres(nmsg_message_t msg, char **pres, const char *endline);
 
nmsg_res
nmsg_message_to_json(nmsg_message_t msg, char **json);
 
nmsg_msgmod_t
nmsg_message_get_msgmod(nmsg_message_t msg);
 
nmsg_res
nmsg_message_add_allocation(nmsg_message_t msg, void *ptr);
 
void
nmsg_message_free_allocations(nmsg_message_t msg);
 
int32_t
nmsg_message_get_vid(nmsg_message_t msg);
 
int32_t
nmsg_message_get_msgtype(nmsg_message_t msg);
 
void *
nmsg_message_get_payload(nmsg_message_t msg);
 
size_t
nmsg_message_get_payload_size(nmsg_message_t msg);
 
void
nmsg_message_update(nmsg_message_t msg);
 
void
nmsg_message_compact_payload(nmsg_message_t msg);
 
void
nmsg_message_get_time(nmsg_message_t msg, struct timespec *ts);
 
void
nmsg_message_set_time(nmsg_message_t msg, const struct timespec *ts);
 
uint32_t
nmsg_message_get_source(nmsg_message_t msg);
 
uint32_t
nmsg_message_get_operator(nmsg_message_t msg);
 
uint32_t
nmsg_message_get_group(nmsg_message_t msg);
 
void
nmsg_message_set_source(nmsg_message_t msg, uint32_t source);
 
void
nmsg_message_set_operator(nmsg_message_t msg, uint32_t operator_);
 
void
nmsg_message_set_group(nmsg_message_t msg, uint32_t group);
 
nmsg_res
nmsg_message_get_field(nmsg_message_t msg,
                       const char *field_name,
                       unsigned val_idx,
                       void **data,
                       size_t *len);
 
nmsg_res
nmsg_message_get_field_by_idx(nmsg_message_t msg,
                              unsigned field_idx,
                              unsigned val_idx,
                              void **data,
                              size_t *len);
 
nmsg_res
nmsg_message_get_field_idx(nmsg_message_t msg,
                           const char *field_name,
                           unsigned *idx);
 
nmsg_res
nmsg_message_get_field_name(nmsg_message_t msg,
                            unsigned field_idx,
                            const char **field_name);
 
nmsg_res
nmsg_message_get_field_flags(nmsg_message_t msg,
                             const char *field_name,
                             unsigned *flags);
 
nmsg_res
nmsg_message_get_field_flags_by_idx(nmsg_message_t msg,
                                    unsigned field_idx,
                                    unsigned *flags);
 
nmsg_res
nmsg_message_get_field_type(nmsg_message_t msg,
                            const char *field_name,
                            nmsg_msgmod_field_type *type);
 
nmsg_res
nmsg_message_get_field_type_by_idx(nmsg_message_t msg,
                                   unsigned field_idx,
                                   nmsg_msgmod_field_type *type);
 
nmsg_res
nmsg_message_get_num_fields(nmsg_message_t msg, size_t *n_fields);
 
nmsg_res
nmsg_message_get_num_field_values(nmsg_message_t msg,
                                  const char *field_name,
                                  size_t *n_field_values);
 
nmsg_res
nmsg_message_get_num_field_values_by_idx(nmsg_message_t msg,
                                         unsigned field_idx,
                                         size_t *n_field_values);
 
nmsg_res
nmsg_message_set_field(nmsg_message_t msg,
                       const char *field_name,
                       unsigned val_idx,
                       const uint8_t *data,
                       size_t len);
 
nmsg_res
nmsg_message_set_field_by_idx(nmsg_message_t msg,
                              unsigned field_idx,
                              unsigned val_idx,
                              const uint8_t *data,
                              size_t len);
 
nmsg_res
nmsg_message_enum_name_to_value(nmsg_message_t msg, const char *field_name,
                                const char *name, unsigned *value);
 
nmsg_res
nmsg_message_enum_name_to_value_by_idx(nmsg_message_t msg, unsigned field_idx,
                                       const char *name, unsigned *value);
 
nmsg_res
nmsg_message_enum_value_to_name(nmsg_message_t msg, const char *field_name,
                                unsigned value, const char **name);
 
nmsg_res
nmsg_message_enum_value_to_name_by_idx(nmsg_message_t msg, unsigned field_idx,
                                       unsigned value, const char **name);
 
#endif /* NMSG_MESSAGE_H */