/** Node type: File
 *
 * This file implements the file type for nodes.
 *
 * @file
 * @author Steffen Vogel <stvogel@eonerc.rwth-aachen.de>
 * @copyright 2014-2015, Institute for Automation of Complex Power Systems, EONERC
 *   This file is part of S2SS. All Rights Reserved. Proprietary and confidential.
 *   Unauthorized copying of this file, via any medium is strictly prohibited.
 */
/**
 * @addtogroup file File-IO node type
 * @ingroup node
 * @{
 *********************************************************************************/


#ifndef _FILE_H_
#define _FILE_H_

#include "node.h"

#define FILE_MAX_PATHLEN	512

enum {
	FILE_READ,
	FILE_WRITE
};

struct file {
	struct file_direction {
		FILE *handle;		/**< libc: stdio file handle */

		const char *mode;	/**< libc: fopen() mode */
		const char *fmt;	/**< Format string for file name. */

		char *path;		/**< Real file name */
		
		int chunk;		/**< Current chunk number. */
		int split;		/**< Split file every file::split mega bytes. */
	} read, write;

	enum read_epoch_mode {
		EPOCH_DIRECT,
		EPOCH_WAIT,
		EPOCH_RELATIVE,
		EPOCH_ABSOLUTE
	} read_epoch_mode;		/**< Specifies how file::offset is calculated. */

	struct timespec read_first;	/**< The first timestamp in the file file::path_in */
	struct timespec read_epoch;	/**< The epoch timestamp from the configuration. */
	struct timespec read_offset;	/**< An offset between the timestamp in the input file and the current time */

	int read_sequence;		/**< Sequence number of last message which has been written to file::path_out */
	int read_timer;			/**< Timer file descriptor. Blocks until 1 / rate seconds are elapsed. */
	double read_rate;		/**< The read rate. */
};

/** @see node_vtable::init */
int file_init(int argc, char *argv[], struct settings *set);

/** @see node_vtable::deinit */
int file_deinit();

/** @see node_vtable::print */
char * file_print(struct node *n);

/** @see node_vtable::parse */
int file_parse(struct node *n, config_setting_t *cfg);

/** @see node_vtable::open */
int file_open(struct node *n);

/** @see node_vtable::close */
int file_close(struct node *n);

/** @see node_vtable::read */
int file_read(struct node *n, struct msg *pool, int poolsize, int first, int cnt);

/** @see node_vtable::write */
int file_write(struct node *n, struct msg *pool, int poolsize, int first, int cnt);

#endif /** _FILE_H_ @} */