ngcbSTREAM Class Reference

#include <ngcbSTREAM.hpp>

Inheritance diagram for ngcbSTREAM:

Public Member Functions
	ngcbSTREAM (FILE *fd)
	Constructor for parallel stram.
	ngcbSTREAM (FILE *fd, ssize_t bufferSize)
	Constructor defining a streaming buffer size.
virtual	~ngcbSTREAM ()
	Destructor.
size_t	Write (const char *buffer, size_t size)
	Write size bytes of buffer to the stream.
int	Send (const char *buffer, size_t size)
	Send size bytes of buffer to the stream.
char *	ErrMsg ()
	Return error message.
int	Initialized ()
	Check class initialization.
Public Member Functions inherited from ngcbTHREAD
	ngcbTHREAD ()
	Normal constructor.
	ngcbTHREAD (ngcbTHREAD *app, ngcbPROCESS_T process, void *arg, size_t stack=0)
	Constructor starting a new thread.
virtual	~ngcbTHREAD ()
	Destructor.
virtual ngcbTHREAD *	NewThread (ngcbTHREAD *app, ngcbPROCESS_T process, void *arg, size_t stack=0)
	Process to be overloaded.
int	ThrCreate (ngcbTHREAD *app, ngcbPROCESS_T process, void *arg, ngcbTHREAD_T *threadId, size_t stack, char *erms=NULL)
	Thread creation.
void	ThrExit ()
	Thread exit.
int	ThrKill (ngcbTHREAD_T threadId, int sig, char *erms=NULL)
	Cancel thread by thread-id.
int	ThrKill (int sig, char *erms=NULL)
	Cancel this thread.
int	ThrJoin (ngcbTHREAD_T threadId, char *erms=NULL)
	Wait for a thread.
int	ThrJoin (char *erms=NULL)
	Wait for this thread.
ngcbTHREAD_T	ThreadId ()
	Get own thread-Id.
int	ThrEqual (ngcbTHREAD_T t1, ngcbTHREAD_T t2)
	Test the equality of the two threads t1 and t2.
int	Initialized ()
	Return flag for successful initialization.
int	FdOut ()
	Return file descrioptor to wakeup a thread.
int	FdIn ()
	Return file descriptor to be used by the thread for wakeup call.
void *	ExecProc ()
	Entry point for c-linkage thread.

Detailed Description

Parallel streaming class

Constructor & Destructor Documentation

ngcbSTREAM() [1/2]

ngcbSTREAM::ngcbSTREAM ( FILE * fd )

inlineexplicit

Constructor for parallel stram.

ngcbSTREAM() [2/2]

ngcbSTREAM::ngcbSTREAM ( FILE * fd, ssize_t bufferSize )

inline

Constructor defining a streaming buffer size.

~ngcbSTREAM()

virtual ngcbSTREAM::~ngcbSTREAM ( )

inlinevirtual

Destructor.

Member Function Documentation

ErrMsg()

char * ngcbSTREAM::ErrMsg ( )

inline

Return error message.

Initialized()

int ngcbSTREAM::Initialized ( )

inline

Check class initialization.

Send()

int ngcbSTREAM::Send ( const char * buffer, size_t size )

inline

Send size bytes of buffer to the stream.

Write()

size_t ngcbSTREAM::Write ( const char * buffer, size_t size )

inline

Write size bytes of buffer to the stream.

---

The documentation for this class was generated from the following file:

• core/ngcbTHREAD/src/include/ngc/core/ngcbSTREAM.hpp