oc_knx_fp.h

Go to the documentation of this file.

/*
// Copyright (c) 2021-2022 Cascoda Ltd
//
// 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 OC_KNX_FP_INTERNAL_H
#define OC_KNX_FP_INTERNAL_H
 
#include <stddef.h>
#include "oc_helpers.h"
#include "oc_ri.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum {
  OC_CFLAG_NONE = 0, 
  OC_CFLAG_COMMUNICATION =
    1 << 2, 
  OC_CFLAG_READ = 1 << 3, 
  OC_CFLAG_WRITE =
    1 << 4, 
  OC_CFLAG_INIT = 1 << 5, 
  OC_CFLAG_TRANSMISSION =
    1 << 6, 
  OC_CFLAG_UPDATE =
    1 << 7, 
} oc_cflag_mask_t;
 
void oc_print_cflags(oc_cflag_mask_t cflags);
 
void oc_cflags_as_string(char *buffer, oc_cflag_mask_t cflags);
 
typedef struct oc_group_object_table_t
{
  int id;                 
  oc_string_t href;       
  oc_cflag_mask_t cflags; 
  int ga_len;             
  uint32_t *ga;           
} oc_group_object_table_t;
 
typedef struct oc_group_rp_table_t
{
  int id;           
  int ia;           
  int64_t iid;      
  int64_t fid;      
  uint32_t grpid;   
  oc_string_t path; 
  oc_string_t url;  
  oc_string_t at;   
  uint32_t *ga;     
  int ga_len;       
  bool non; 
  int mt;   
} oc_group_rp_table_t;
 
int oc_print_reduced_group_publisher_table(void);
 
int oc_print_reduced_group_recipient_table(void);
 
int oc_table_find_id_from_rep(oc_rep_t *object);
 
int oc_core_set_group_object_table(int index, oc_group_object_table_t entry);
 
int oc_core_get_group_object_table_total_size();
 
oc_group_object_table_t *oc_core_get_group_object_table_entry(int index);
 
int find_empty_slot_in_group_object_table(int id);
 
void oc_register_group_multicasts();
 
uint32_t oc_find_grpid_in_publisher_table(uint32_t group_address);
 
uint32_t oc_find_grpid_in_recipient_table(uint32_t group_address);
 
void oc_init_datapoints_at_initialization();
 
int oc_core_find_index_in_group_object_table_from_id(int id);
 
int oc_core_find_group_object_table_index(uint32_t group_address);
 
int oc_core_find_next_group_object_table_index(uint32_t group_address,
                                               int cur_index);
 
int oc_core_find_group_object_table_url(const char *url);
 
int oc_core_find_next_group_object_table_url(const char *url, int cur_index);
 
oc_cflag_mask_t oc_core_group_object_table_cflag_entries(int index);
 
oc_string_t oc_core_find_group_object_table_url_from_index(int index);
 
int oc_core_find_group_object_table_number_group_entries(int index);
 
int oc_core_find_group_object_table_group_entry(int index, int entry);
 
void oc_print_group_object_table_entry(int entry);
 
void oc_dump_group_object_table_entry(int entry);
 
void oc_load_group_object_table_entry(int entry);
 
void oc_load_group_object_table();
 
void oc_delete_group_object_table_entry(int entry);
 
void oc_delete_group_object_table();
 
void oc_delete_group_rp_table();
 
bool oc_core_check_recipient_index_on_group_address(int index,
                                                    uint32_t group_address);
 
char *oc_core_get_recipient_index_url_or_path(int index);
 
uint32_t oc_core_get_recipient_ia(int index);
 
int oc_core_get_recipient_table_size();
 
oc_group_rp_table_t *oc_core_get_recipient_table_entry(int index);
 
int oc_core_find_empty_slot_in_recipient_table(int id);
 
int oc_core_find_index_in_recipient_table_from_id(int id);
 
int oc_core_add_recipient_entry(int index, oc_group_rp_table_t entry);
 
int oc_core_get_publisher_table_size();
 
oc_group_rp_table_t *oc_core_get_publisher_table_entry(int index);
 
int oc_core_add_publisher_entry(int index, oc_group_rp_table_t entry);
int oc_core_find_empty_slot_in_publisher_table(int id);
 
int oc_core_find_index_in_publisher_table_from_id(int id);
 
bool oc_add_points_in_group_object_table_to_response(oc_request_t *request,
                                                     size_t device_index,
                                                     uint32_t group_address,
                                                     size_t *response_length,
                                                     int matches);
 
bool oc_belongs_href_to_resource(oc_string_t href, bool discoverable,
                                 size_t device_index);
 
void oc_create_knx_fp_resources(size_t device_index);
 
void oc_free_knx_fp_resources(size_t device_index);
 
oc_endpoint_t oc_create_multicast_group_address(oc_endpoint_t in,
                                                uint32_t group_nr, int64_t iid,
                                                int scope);
 
oc_endpoint_t oc_create_multicast_group_address_with_port(oc_endpoint_t in,
                                                          uint32_t group_nr,
                                                          int64_t iid,
                                                          int scope, int port);
 
void subscribe_group_to_multicast(uint32_t group_nr, int64_t iid, int scope);
 
void subscribe_group_to_multicast_with_port(uint32_t group_nr, int64_t iid,
                                            int scope, int port);
 
void unsubscribe_group_to_multicast(uint32_t group_nr, int64_t iid, int scope);
 
void unsubscribe_group_to_multicast_with_port(uint32_t group_nr, int64_t iid,
                                              int scope, int port);
 
#ifdef __cplusplus
}
#endif
 
#endif /* OC_KNX_FP_INTERNAL_H */