ImageStreamIO.h File Reference

Go to the source code of this file.

Functions
void	__attribute__ ((constructor)) libinit_ImageStreamIO()
int_fast8_t	init_ImageStreamIO ()
ImageStreamIO - 1. READ / WRITE STREAM
int	ImageStreamIO_createIm (IMAGE *image, const char *name, long naxis, uint32_t *size, uint8_t atype, int shared, int NBkw)
	Create shared memory image stream. More...
long	ImageStreamIO_read_sharedmem_image_toIMAGE (const char *name, IMAGE *image)
	Read / connect to existing shared memory image stream. More...
ImageStreamIO - 2. MANAGE SEMAPHORES
int	ImageStreamIO_createsem (IMAGE *image, long NBsem)
	Create shmim semaphores. More...
long	ImageStreamIO_sempost (IMAGE *image, long index)
	Post all shmim semaphores. More...
long	ImageStreamIO_sempost_excl (IMAGE *image, long index)
	Post all shmim semaphores except one. More...
long	ImageStreamIO_sempost_loop (IMAGE *image, long index, long dtus)
	Post shmim semaphores at regular time interval. More...
long	ImageStreamIO_semwait (IMAGE *image, long index)
	Wait for semaphore. More...
long	ImageStreamIO_semflush (IMAGE *image, long index)
	Flush all semaphores of a shmim. More...

Function Documentation

void __attribute__

(

(constructor)

)

int ImageStreamIO_createIm	(	IMAGE *	image,
		const char *	name,
		long	naxis,
		uint32_t *	size,
		uint8_t	atype,
		int	shared,
		int	NBkw
	)

Create shared memory image stream.

Parameters

[out]	image	IMAGE structure which will have its members allocated and initialized.
[in]	name	the name of the shared memory file will be SHAREDMEMDIR/<name>_im.shm
[in]	naxis	number of axes in the image.
[in]	size	the size of the image along each axis. Must have naxis elements.
[in]	atype	data type code
[in]	shared	if true then a shared memory buffer is allocated. If false, only local storage is used.
[in]	NBkw	the number of keywords to allocate.

int ImageStreamIO_createsem	(	IMAGE *	image,
		long	NBsem
	)

Create shmim semaphores.

Purpose

Create semaphore of a shmim

Arguments

Parameters

[in]	image	IMAGE* pointer to shmim
[in]	NBsem	number of semaphores to be created

long ImageStreamIO_read_sharedmem_image_toIMAGE	(	const char *	name,
		IMAGE *	image
	)

Read / connect to existing shared memory image stream.

Parameters

[in]	name	the name of the shared memory file to access, as in SHAREDMEMDIR/<name>_im.shm
[out]	image	the IMAGE structure to connect to the stream

long ImageStreamIO_semflush	(	IMAGE *	image,
		long	index
	)

Flush all semaphores of a shmim.

Purpose

Flush shmim semaphore

Arguments

Parameters

[in]	image	IMAGE* pointer to shmim
[in]	index	semaphore index flush all semaphores if index<0

long ImageStreamIO_sempost	(	IMAGE *	image,
		long	index
	)

Post all shmim semaphores.

Purpose

Posts semaphore of a shmim if index < 0, post all semaphores

Arguments

Parameters

[in]	image	IMAGE* pointer to shmim
[in]	index	semaphore index index of semaphore to be posted if index=-1, post all semaphores

long ImageStreamIO_sempost_excl	(	IMAGE *	image,
		long	index
	)

Post all shmim semaphores except one.

Purpose

Posts all semaphores of a shmim except one

Arguments

Parameters

[in]	image	IMAGE* pointer to shmim
[in]	index	semaphore index index of semaphore to be excluded

long ImageStreamIO_sempost_loop	(	IMAGE *	image,
		long	index,
		long	dtus
	)

Post shmim semaphores at regular time interval.

Purpose

Posts all semaphores of a shmim at regular time intervals

Arguments

Parameters

[in]	image	IMAGE* pointer to shmim
[in]	index	semaphore index is =-1, post all semaphores
[in]	dtus	time interval [us]

long ImageStreamIO_semwait	(	IMAGE *	image,
		long	index
	)

Wait for semaphore.

Purpose

Wait on a shmim semaphore

Arguments

Parameters

[in]	image	IMAGE* pointer to shmim
[in]	index	semaphore index

int_fast8_t init_ImageStreamIO

(

)