Files
bacnet_stack/src/bacnet/basic/object/bacfile.h
T
Steve Karg 770be70688 Chore/bacnet-sc-unrelated-cleanup (#620)
* Added required linux Ethernet library for ethernet build

* Added .obj to gitignore

* Fixed BACnet port for APPLE to use BSD in CMake

* Changed format in CMake to enable cleaner SC merge

* Added create-object and delete-object recipes in GCC Makefile

* Added datalink timer to all example OS apps

* Changed most microcontroller ports to use BACAPP_MINIMAL to specify which datatypes can be written.

* Fixed zephyr OS for BACnet/IP warning

* Fixed zephyr OS log to not require log_strdup

* Added writefile API to file object example

* Added API to device-client to make it more robust.

* Added API in network-port object for getting the ASCII object-name

* Added debug print with a timestamp option

* Added debug print with hex dump print

* Added API to network port object for activate and discard

* Added default define for debug with timestamp

* Added prototype in header for disabled debug printf.

* Added fifo peek ahead function to peek at more than one byte.

* Added get-mac value for network port that uses buffer rather than octetstring
2024-04-19 12:54:56 -05:00

200 lines
5.8 KiB
C

/*####COPYRIGHTBEGIN####
-------------------------------------------
Copyright (C) 2005 Steve Karg
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to:
The Free Software Foundation, Inc.
59 Temple Place - Suite 330
Boston, MA 02111-1307, USA.
As a special exception, if other files instantiate templates or
use macros or inline functions from this file, or you compile
this file and link it with other works to produce a work based
on this file, this file does not by itself cause the resulting
work to be covered by the GNU General Public License. However
the source code for this file must still be made available in
accordance with section (3) of the GNU General Public License.
This exception does not invalidate any other reasons why a work
based on this file might be covered by the GNU General Public
License.
-------------------------------------------
####COPYRIGHTEND####*/
#ifndef BACFILE_H
#define BACFILE_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
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