ngcppFile.c File Reference

#include <ngc/core/ngcpp.h>

Classes
struct	ngcpp_file_t

Macros
#define	ngcppMAX_FILE_PUB   32
#define	ngcppFILE_QUEUE_SIZE   128

Functions
int	ngcppFilePublisherInit (const char *name, char *erms)
int	ngcppFilePublish (ngcppFRAME *frame, int bufIdx, int sync, char *erms)
void	ngcppFileSync (void)
int	ngcppFilePublisherPath (int id, const char *path, char *erms)
void	ngcppFilePublisherBase (const char *base)

Variables
int	ngcppNumFilePub = 0
int	ngcppFileDump = 0
int	ngcppFileId = -1
char	ngcppBaseName [256]

Detailed Description

Copyright

SPDX-FileCopyrightText: 2026 European Southern Observatory (ESO) SPDX-License-Identifier: LGPL-3.0-only

Macro Definition Documentation

ngcppFILE_QUEUE_SIZE

#define ngcppFILE_QUEUE_SIZE   128

Maximum number of files in queue

ngcppMAX_FILE_PUB

#define ngcppMAX_FILE_PUB   32

Maximum number of file publishersservers

Function Documentation

ngcppFilePublish()

int ngcppFilePublish	(	ngcppFRAME *	frame,
		int	bufIdx,
		int	sync,
		char *	erms )

Store the frame-buffer to a file. If sync is set to 1 then the routine blocks until a place in the file-output queue is free. bufIdx is the index of the frame within the circular output buffer of the frame.

ngcppFilePublisherBase()

void ngcppFilePublisherBase

(

const char *

base

)

Change the file publishing sequence base-name. The header information (frame-type, counter) is always appended to the basename.

ngcppFilePublisherInit()

int ngcppFilePublisherInit	(	const char *	name,
		char *	erms )

Intialize a file publisher. The name may specify a path or a socket connection (host:port).

ngcppFilePublisherPath()

int ngcppFilePublisherPath	(	int	id,
		const char *	path,
		char *	erms )

Change the storaga path of a file publisher.

ngcppFileSync()

void ngcppFileSync

(

void

)

Waits until the file queues of all file publishers are empty.

Variable Documentation

ngcppBaseName

char ngcppBaseName[256]

Base-name for file publisher

ngcppFileDump

int ngcppFileDump = 0

Flag to enable/disable file-dump mode

ngcppFileId

int ngcppFileId = -1

File server id for file-dump

ngcppNumFilePub

int ngcppNumFilePub = 0

Number of file publishers