Tscope5
Functions | Variables
cedrusbox_internal.c File Reference

Definitions of internal cedrusbox functions. More...

Go to the source code of this file.

Functions

void ts5_check_cedrusbox (char *calling_function)
 Do some checks at the start of each cedrusbox function.
void ts5_install_cedrusbox (char *calling_function)
 Install the cedrusbox subsystem.
void ts5_uninstall_cedrusbox ()
 Uninstall the cedrusbox subsystem.
unsigned int ts5_read_cedrusbox (int port, char *buff, unsigned long bytes_to_read)
 Read text from a cedrusbox.
unsigned int ts5_write_cedrusbox (int port, char *buff, unsigned long bytes_to_write)
 Write text to a cedrusbox.
void ts5_fflush_cedrusbox (int port)
 Flush the output of a cedrusbox.
void * ts5_cedrusbox_threadfunc ()
 Cedrusbox thread function.

Variables

int _ts5_is_cedrusbox_installed = 0
 Is the cedrusbox subsystem installed?

Detailed Description

Definitions of internal cedrusbox functions.

Definition in file cedrusbox_internal.c.


Function Documentation

void ts5_check_cedrusbox ( char *  calling_function)

Do some checks at the start of each cedrusbox function.

Parameters:
calling_functionName the function that calls for this check or installation.

Checks whether the cedrusbox subsystem is installed. If not, the cedrusbox subsystem is installed.

Definition at line 40 of file cedrusbox_internal.c.

void ts5_install_cedrusbox ( char *  calling_function)

Install the cedrusbox subsystem.

Parameters:
calling_functionName the function that calls for this check or installation.

This function is called automatically if necessary.

Definition at line 57 of file cedrusbox_internal.c.

void ts5_uninstall_cedrusbox ( )

Uninstall the cedrusbox subsystem.

This function is called automatically at the end of the program.

Definition at line 294 of file cedrusbox_internal.c.

unsigned int ts5_read_cedrusbox ( int  port,
char *  buff,
unsigned long  bytes_to_read 
)

Read text from a cedrusbox.

Parameters:
portPort number the cedrusbox is attached to.
buffCharacter buffer.
bytes_to_readNumber of bytes to be written.
Returns:
Length of the string that is sent to the port.
Warning:
This is an internal function, no checks are performed.

Definition at line 392 of file cedrusbox_internal.c.

unsigned int ts5_write_cedrusbox ( int  port,
char *  buff,
unsigned long  bytes_to_write 
)

Write text to a cedrusbox.

Parameters:
portPort number the cedrusbox is attached to.
buffCharacter buffer.
bytes_to_writeNumber of bytes to be written.
Returns:
Length of the string that is read.
Warning:
This is an internal function, no checks are performed.

Definition at line 423 of file cedrusbox_internal.c.

void ts5_fflush_cedrusbox ( int  port)

Flush the output of a cedrusbox.

Parameters:
portPort number the cedrusbox is attached to.
Warning:
This is an internal function, no checks are performed.

Definition at line 450 of file cedrusbox_internal.c.

void* ts5_cedrusbox_threadfunc ( )

Cedrusbox thread function.

Warning:
This is an internal function, no checks are performed.

Definition at line 469 of file cedrusbox_internal.c.


Variable Documentation

int _ts5_is_cedrusbox_installed = 0

Is the cedrusbox subsystem installed?

Definition at line 20 of file cedrusbox_internal.c.