Steve Karg
3d3e192ae9
* Added basic object-name get for ASCII names to enable free if they were dynamically created. Added unit testing to validate the basic object ASCII object-name API. * Removed static scope on character array used for name since the array gets copied into characterstring array and static is not needed.
178 lines
4.7 KiB
C
178 lines
4.7 KiB
C
/**
|
|
* @file
|
|
* @author Steve Karg
|
|
* @date 2005
|
|
* @brief API for a basic BACnet File Object implementation.
|
|
* @copyright SPDX-License-Identifier: MIT
|
|
*/
|
|
#ifndef BACNET_BASIC_OBJECT_FILE_H
|
|
#define BACNET_BASIC_OBJECT_FILE_H
|
|
#include <stdbool.h>
|
|
#include <stdint.h>
|
|
/* BACnet Stack defines - first */
|
|
#include "bacnet/bacdef.h"
|
|
/* BACnet Stack API */
|
|
#include "bacnet/bacint.h"
|
|
#include "bacnet/datetime.h"
|
|
#include "bacnet/apdu.h"
|
|
#include "bacnet/arf.h"
|
|
#include "bacnet/awf.h"
|
|
#include "bacnet/rp.h"
|
|
#include "bacnet/wp.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif /* __cplusplus */
|
|
|
|
BACNET_STACK_EXPORT
|
|
void BACfile_Property_Lists(
|
|
const int **pRequired,
|
|
const int **pOptional,
|
|
const int **pProprietary);
|
|
|
|
BACNET_STACK_EXPORT
|
|
bool bacfile_object_name(
|
|
uint32_t object_instance,
|
|
BACNET_CHARACTER_STRING * object_name);
|
|
BACNET_STACK_EXPORT
|
|
bool bacfile_object_name_set(
|
|
uint32_t object_instance,
|
|
char *new_name);
|
|
BACNET_STACK_EXPORT
|
|
const char * bacfile_name_ansi(
|
|
uint32_t object_instance);
|
|
|
|
BACNET_STACK_EXPORT
|
|
bool bacfile_valid_instance(
|
|
uint32_t object_instance);
|
|
BACNET_STACK_EXPORT
|
|
uint32_t bacfile_count(
|
|
void);
|
|
BACNET_STACK_EXPORT
|
|
uint32_t bacfile_index_to_instance(
|
|
unsigned find_index);
|
|
BACNET_STACK_EXPORT
|
|
unsigned bacfile_instance_to_index(
|
|
uint32_t instance);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char * bacfile_file_type(
|
|
uint32_t object_instance);
|
|
BACNET_STACK_EXPORT
|
|
void bacfile_file_type_set(
|
|
uint32_t object_instance,
|
|
const char *mime_type);
|
|
|
|
BACNET_STACK_EXPORT
|
|
bool bacfile_archive(
|
|
uint32_t instance);
|
|
BACNET_STACK_EXPORT
|
|
bool bacfile_archive_set(
|
|
uint32_t instance, bool status);
|
|
|
|
BACNET_STACK_EXPORT
|
|
bool bacfile_read_only(
|
|
uint32_t instance);
|
|
BACNET_STACK_EXPORT
|
|
bool bacfile_read_only_set(
|
|
uint32_t object_instance,
|
|
bool read_only);
|
|
|
|
BACNET_STACK_EXPORT
|
|
bool bacfile_file_access_stream(
|
|
uint32_t object_instance);
|
|
BACNET_STACK_EXPORT
|
|
bool bacfile_file_access_stream_set(
|
|
uint32_t object_instance,
|
|
bool access);
|
|
|
|
BACNET_STACK_EXPORT
|
|
BACNET_UNSIGNED_INTEGER bacfile_file_size(
|
|
uint32_t instance);
|
|
BACNET_STACK_EXPORT
|
|
bool bacfile_file_size_set(
|
|
uint32_t object_instance,
|
|
BACNET_UNSIGNED_INTEGER file_size);
|
|
|
|
/* this is one way to match up the invoke ID with */
|
|
/* the file ID from the AtomicReadFile request. */
|
|
/* Another way would be to store the */
|
|
/* invokeID and file instance in a list or table */
|
|
/* when the request was sent */
|
|
BACNET_STACK_EXPORT
|
|
uint32_t bacfile_instance_from_tsm(
|
|
uint8_t invokeID);
|
|
|
|
/* handler ACK helper */
|
|
BACNET_STACK_EXPORT
|
|
bool bacfile_read_stream_data(
|
|
BACNET_ATOMIC_READ_FILE_DATA * data);
|
|
BACNET_STACK_EXPORT
|
|
bool bacfile_read_ack_stream_data(
|
|
uint32_t instance,
|
|
BACNET_ATOMIC_READ_FILE_DATA * data);
|
|
BACNET_STACK_EXPORT
|
|
bool bacfile_write_stream_data(
|
|
BACNET_ATOMIC_WRITE_FILE_DATA * data);
|
|
BACNET_STACK_EXPORT
|
|
bool bacfile_read_record_data(
|
|
BACNET_ATOMIC_READ_FILE_DATA * data);
|
|
BACNET_STACK_EXPORT
|
|
bool bacfile_read_ack_record_data(
|
|
uint32_t instance,
|
|
BACNET_ATOMIC_READ_FILE_DATA * data);
|
|
BACNET_STACK_EXPORT
|
|
bool bacfile_write_record_data(
|
|
BACNET_ATOMIC_WRITE_FILE_DATA * data);
|
|
|
|
/* handling for read property service */
|
|
BACNET_STACK_EXPORT
|
|
int bacfile_read_property(
|
|
BACNET_READ_PROPERTY_DATA * rpdata);
|
|
|
|
/* handling for write property service */
|
|
BACNET_STACK_EXPORT
|
|
bool bacfile_write_property(
|
|
BACNET_WRITE_PROPERTY_DATA * wp_data);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bacfile_pathname(
|
|
uint32_t instance);
|
|
BACNET_STACK_EXPORT
|
|
void bacfile_pathname_set(
|
|
uint32_t instance,
|
|
const char *pathname);
|
|
BACNET_STACK_EXPORT
|
|
uint32_t bacfile_pathname_instance(
|
|
const char *pathname);
|
|
|
|
BACNET_STACK_EXPORT
|
|
uint32_t bacfile_read(
|
|
uint32_t object_instance,
|
|
uint8_t *buffer,
|
|
uint32_t buffer_size);
|
|
BACNET_STACK_EXPORT
|
|
uint32_t bacfile_write(
|
|
uint32_t object_instance,
|
|
uint8_t *buffer,
|
|
uint32_t buffer_size);
|
|
|
|
BACNET_STACK_EXPORT
|
|
uint32_t bacfile_create(
|
|
uint32_t object_instance);
|
|
BACNET_STACK_EXPORT
|
|
bool bacfile_delete(
|
|
uint32_t object_instance);
|
|
BACNET_STACK_EXPORT
|
|
void bacfile_cleanup(
|
|
void);
|
|
BACNET_STACK_EXPORT
|
|
void bacfile_init(
|
|
void);
|
|
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif /* __cplusplus */
|
|
#endif
|