util/utilSocket.h File Reference

#include <arpa/inet.h>
#include <sys/socket.h>
#include <netdb.h>
#include <stdio.h>
#include <stdlib.h>
#include <sys/types.h>
#include <string.h>
#include <limits.h>
#include <math.h>
#include <errno.h>
#include "defines.h"

Include dependency graph for util/utilSocket.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	HEADER_LENGTH   54

Functions
int	save_append (char **buffer, const char *toAdd, int *bufLen)
	Appends a character array to another character array. More...
int	assembleBuffer (int flag, int nDbl, int nInt, int nBoo, double curSimTim, double dblVal[], int intVal[], int booVal[], char **buffer, int *bufLen)
	Assembles the buffer that will be exchanged through the IPC. More...
int	getIntCheckError (const char *nptr, char **endptr, const int base, int *val)
	Gets an integer and does the required error checking. More...
int	getDoubleCheckError (const char *nptr, char **endptr, double *val)
	Gets a double and does the required error checking. More...
int	disassembleHeaderBuffer (const char *buffer, char **endptr, const int base, int *fla, int *nDbl, int *nInt, int *nBoo)
	Disassembles the header of the buffer that has been received through the IPC. More...
int	disassembleBuffer (const char *buffer, int *fla, int *nDbl, int *nInt, int *nBoo, double *curSimTim, double dblVal[], int intVal[], int booVal[])
	Disassembles the buffer that has been received through the IPC. More...
int	getsocketportnumber (const char *const docname)
	Gets the port number for the BSD socket communication. More...
int	getsockethost (const char *const docname, char *const hostname)
	Gets the hostname for the BSD socket communication. More...
int	getmainversionnumber ()
	Returns the main version number of the client. More...
int	establishclientsocket (const char *const docname)
	Establishes a connection to the socket. More...
int	writetosocket (const int *sockfd, const int *flaWri, const int *nDblWri, const int *nIntWri, const int *nBooWri, double *curSimTim, double dblValWri[], int intValWri[], int booValWri[])
	Writes data to the socket. More...
int	sendclientmessage (const int *sockfd, const int *flaWri)
	Writes a message flag to the socket stream. More...
int	sendclienterror (const int *sockfd, const int *flaWri)
	Writes an error flag to the socket stream. More...
int	getRequiredReadBufferLength (const int *sockfd)
	Returns the required socket buffer length by reading from the socket how many data it contains. More...
int	getrequiredbufferlength (const int nDbl, const int nInt, const int nBoo)
	Returns the required socket buffer length. More...
int	readfromsocket (const int *sockfd, int *flaRea, int *nDblRea, int *nIntRea, int *nBooRea, double *curSimTim, double dblValRea[], int intValRea[], int booValRea[])
	Reads data from the socket. More...
int	readbufferfromsocket (const int *sockfd, char *buffer, int *bufLen)
	Reads a character buffer from the socket. More...
int	exchangewithsocket (const int *sockfd, const int *flaWri, int *flaRea, const int *nDblWri, const int *nIntWri, const int *nBooWri, int *nDblRea, int *nIntRea, int *nBooRea, double *simTimWri, double dblValWri[], int intValWri[], int booValWri[], double *simTimRea, double dblValRea[], int intValRea[], int booValRea[])
	Exchanges data with the socket. More...
int	exchangedoubleswithsocket (const int *sockfd, const int *flaWri, int *flaRea, const int *nDblWri, int *nDblRea, double *simTimWri, double dblValWri[], double *simTimRea, double dblValRea[])
	Exchanges data with the socket. More...
int	exchangedoubleswithsocketFMU (const int *sockfd, const int *flaWri, int *flaRea, const int *nDblWri, int *nDblRea, double *simTimWri, double dblValWri[], double *simTimRea, double dblValRea[], const int *flaExport)
	Exchanges data with the socket. More...
int	closeipc (int *sockfd)
	Closes the inter process communication socket. More...

Variables
FILE *	f1 = NULL
int	REQUIRED_READ_LENGTH = 0
int	REQUIRED_WRITE_LENGTH = 0
int	SERVER_VERSION = 0
	This will be overwritten to contain the version number of the server. More...

Macro Definition Documentation

#define HEADER_LENGTH   54

Definition at line 137 of file util/utilSocket.h.

Referenced by getrequiredbufferlength(), and getRequiredReadBufferLength().

Function Documentation

int assembleBuffer	(	int	flag,
		int	nDbl,
		int	nInt,
		int	nBoo,
		double	curSimTim,
		double	dblVal[],
		int	intVal[],
		int	booVal[],
		char **	buffer,
		int *	bufLen
	)

Assembles the buffer that will be exchanged through the IPC.

Parameters

flag	The communication flag.
nDbl	The number of double values.
nInt	The number of integer values.
nBoo	The number of boolean values.
dblVal	The array that stores the double values.
intVal	The array that stores the integer values.
booVal	The array that stores the boolean values.
buffer	The buffer into which the values will be written.
bufLen	The buffer length prior and after the call.

Returns

0 if no error occurred.

Definition at line 159 of file util/utilSocket.c.

References i, MAINVERSION, retVal, and save_append().

Referenced by writetosocket().

int closeipc

(

int *

sockfd

)

Closes the inter process communication socket.

Parameters

sockfd

Socket file descripter.

Returns

The return value of the close function.

Parameters

sockfd

Socket file descripter.

Returns

Zero.

Definition at line 1193 of file util/utilSocket.c.

int disassembleBuffer	(	const char *	buffer,
		int *	fla,
		int *	nDbl,
		int *	nInt,
		int *	nBoo,
		double *	curSimTim,
		double	dblVal[],
		int	intVal[],
		int	booVal[]
	)

Disassembles the buffer that has been received through the IPC.

Parameters

buffer	The buffer that contains the values to be parsed.
flag	The communication flag.
nDbl	The number of double values received.
nInt	The number of integer values received.
nBoo	The number of boolean values received.
dblVal	The array that stores the double values.
intVal	The array that stores the integer values.
booVal	The array that stores the boolean values.

Returns

0 if no error occurred.

Definition at line 343 of file util/utilSocket.c.

References disassembleHeaderBuffer(), f1, fprintf(), getDoubleCheckError(), getIntCheckError(), i, and retVal.

Referenced by readfromsocket().

int disassembleHeaderBuffer	(	const char *	buffer,
		char **	endptr,
		const int	base,
		int *	fla,
		int *	nDbl,
		int *	nInt,
		int *	nBoo
	)

Disassembles the header of the buffer that has been received through the IPC.

This method is separated from disassemblebuffer since in the first call, we only need to peek at the header to assign a long enough buffer for the read operation.

Parameters

buffer	The buffer that contains the values to be parsed.
flag	The communication flag.
nDbl	The number of double values received.
nInt	The number of integer values received.
nBoo	The number of boolean values received.

Returns

0 if no error occurred.

Definition at line 297 of file util/utilSocket.c.

References getIntCheckError(), i, retVal, and SERVER_VERSION.

Referenced by disassembleBuffer(), and getRequiredReadBufferLength().

int establishclientsocket

(

const char *const

docname

)

Establishes a connection to the socket.

This method establishes the client socket.

Parameters

docname

Name of xml file that contains the socket information.

Returns

The socket file descripter, or a negative value if an error occured.

This method establishes the client socket.

Parameters

docname

Name of xml file that contains the socket information.

Returns

Negative one.

Definition at line 468 of file util/utilSocket.c.

int exchangedoubleswithsocket	(	const int *	sockfd,
		const int *	flaWri,
		int *	flaRea,
		const int *	nDblWri,
		int *	nDblRea,
		double *	simTimWri,
		double	dblValWri[],
		double *	simTimRea,
		double	dblValRea[]
	)

Exchanges data with the socket.

Clients can call this method to exchange data through the socket.

Parameters

sockfd	Socket file descripter
flaWri	Communication flag to write to the socket stream.
flaRea	Communication flag read from the socket stream.
nDblWri	Number of double values to write.
nDblRea	Number of double values to read.
simTimWri	Current simulation time in seconds to write.
dblValWri	Double values to write.
simTimRea	Current simulation time in seconds read from socket.
dblValRea	Double values read from socket.

See Also

int establishclientsocket(uint16_t *portNo)

Returns

The exit value of send or read, or a negative value if an error occured.

Definition at line 1119 of file util/utilSocket.c.

int exchangedoubleswithsocketFMU	(	const int *	sockfd,
		const int *	flaWri,
		int *	flaRea,
		const int *	nDblWri,
		int *	nDblRea,
		double *	simTimWri,
		double	dblValWri[],
		double *	simTimRea,
		double	dblValRea[],
		const int *	flaExport
	)

Exchanges data with the socket.

Clients can call this method to exchange data through the socket. This methods differs from the exchangedoubleswithsocket. It has a flag that is used to set a global variable in readbufferfromsocket.

Parameters

sockfd	Socket file descripter
flaWri	Communication flag to write to the socket stream.
flaRea	Communication flag read from the socket stream.
nDblWri	Number of double values to write.
nDblRea	Number of double values to read.
simTimWri	Current simulation time in seconds to write.
dblValWri	Double values to write.
simTimRea	Current simulation time in seconds read from socket.
dblValRea	Double values read from socket.
flaexport	Flag for FMUExport.

See Also

int establishclientsocket(uint16_t *portNo)

Returns

The exit value of send or read, or a negative value if an error occured.

Definition at line 1160 of file util/utilSocket.c.

References exchangewithsocket(), and FMUEXPORT.

int exchangewithsocket	(	const int *	sockfd,
		const int *	flaWri,
		int *	flaRea,
		const int *	nDblWri,
		const int *	nIntWri,
		const int *	nBooWri,
		int *	nDblRea,
		int *	nIntRea,
		int *	nBooRea,
		double *	simTimWri,
		double	dblValWri[],
		int	intValWri[],
		int	booValWri[],
		double *	simTimRea,
		double	dblValRea[],
		int	intValRea[],
		int	booValRea[]
	)

Exchanges data with the socket.

Clients can call this method to exchange data through the socket.

Parameters

sockfd	Socket file descripter
flaWri	Communication flag to write to the socket stream.
flaRea	Communication flag read from the socket stream.
nDblWri	Number of double values to write.
nIntWri	Number of integer values to write.
nBooWri	Number of boolean values to write.
nDblRea	Number of double values to read.
nIntRea	Number of integer values to read.
nBooRea	Number of boolean values to read.
simTimWri	Current simulation time in seconds to write.
dblValWri	Double values to write.
intValWri	Integer values to write.
boolValWri	Boolean values to write.
simTimRea	Current simulation time in seconds read from socket.
dblValRea	Double values read from socket.
intValRea	Integer values read from socket.
boolValRea	Boolean values read from socket.

See Also

int establishclientsocket(uint16_t *portNo)

Returns

The exit value of send or read, or a negative value if an error occured.

Definition at line 1049 of file util/utilSocket.c.

References f1, fprintf(), getrequiredbufferlength(), readfromsocket(), REQUIRED_WRITE_LENGTH, retVal, and writetosocket().

Referenced by exchangedoubleswithsocket(), and exchangedoubleswithsocketFMU().

int getDoubleCheckError	(	const char *	nptr,
		char **	endptr,
		double *	val
	)

Gets a double and does the required error checking.

Parameters

nptr	Pointer to character buffer that contains the number.
endptr	After return, this variable contains a pointer to the character after the last character of the number.
The	value contained in the character buffer.

Returns

0 if no error occurred.

Definition at line 264 of file util/utilSocket.c.

References fprintf().

Referenced by disassembleBuffer().

int getIntCheckError	(	const char *	nptr,
		char **	endptr,
		const int	base,
		int *	val
	)

Gets an integer and does the required error checking.

Parameters

nptr	Pointer to character buffer that contains the number.
endptr	After return, this variable contains a pointer to the character after the last character of the number.
base	Base for the integer.
The	value contained in the character buffer.

Returns

0 if no error occurred.

Definition at line 227 of file util/utilSocket.c.

References FMUEXPORT, and fprintf().

Referenced by disassembleBuffer(), and disassembleHeaderBuffer().

int getmainversionnumber

(

)

Returns the main version number of the client.

This method returns the version number. A negative return value is used in a dummy dll to check in EnergyPlus whether the BCVTB has been installed.

Returns

The main version number, or a negative value if an error occured.

Returns the main version number of the client.

This method returns the version number of the client. A negative return value is used in a dummy dll to check in EnergyPlus whether the BCVTB has been installed.

Returns

The main version number, or a negative value if an error occured.

Returns the main version number of the client.

This method returns the version number. A negative return value is used in a dummy dll to check in EnergyPlus whether the BCVTB has been installed.

Returns

Negative one.

Definition at line 443 of file util/utilSocket.c.

int getrequiredbufferlength	(	const int	nDbl,
		const int	nInt,
		const int	nBoo
	)

Returns the required socket buffer length.

Parameters

nDbl	Number of double values to read or write.
nInt	Number of integer values to read or write.
nBoo	Number of boolean values to read or write.
nDbl	Number of double values to read or write.
nInt	Number of integer values to read or write.
nBoo	Number of boolean values to read or write.

Returns

nCha The nunber of characters needed to store the buffer

Definition at line 867 of file util/utilSocket.c.

References fprintf(), HEADER_LENGTH, and retVal.

Referenced by exchangewithsocket(), and getRequiredReadBufferLength().

int getRequiredReadBufferLength

(

const int *

sockfd

)

Returns the required socket buffer length by reading from the socket how many data it contains.

This method also set the global variable SERVER_VERSION

Parameters

sockfd

Socket file descripter

Returns

nCha The nunber of characters needed to store the buffer

Definition at line 830 of file util/utilSocket.c.

References disassembleHeaderBuffer(), getrequiredbufferlength(), HEADER_LENGTH, and retVal.

Referenced by readfromsocket().

int getsockethost	(	const char *const	docname,
		char *const	hostname
	)

Gets the hostname for the BSD socket communication.

This method parses the xml file for the socket host name.

Parameters

docname	Name of xml file.
hostname	The hostname will be written to this argument.

Returns

0 if successful, or -1 if an error occured.

Definition at line 454 of file util/utilSocket.c.

References BUFFER_LENGTH, getxmlvalue(), i, and r.

Referenced by establishclientsocket().

int getsocketportnumber

(

const char *const

docname

)

Gets the port number for the BSD socket communication.

This method parses the xml file for the socket number.

Parameters

docname

Name of xml file.

Returns

the socket port number if successful, or -1 if an error occured.

This method parses the xml file for the socket number.

Parameters

docname

Name of xml file.

Returns

Negative one.

Definition at line 413 of file util/utilSocket.c.

int readbufferfromsocket	(	const int *	sockfd,
		char *	buffer,
		int *	bufLen
	)

Reads a character buffer from the socket.

This method is called by readfromsocket.

Parameters

sockfd	The socket file descripter.
buffer	The buffer into which the values will be written.
bufLen	The buffer length prior to the call.

Returns

The exit value of the read command.

Definition at line 977 of file util/utilSocket.c.

References f1, fprintf(), REQUIRED_READ_LENGTH, retVal, and SERVER_VERSION.

Referenced by readfromsocket(), and sendclientmessage().

int readfromsocket	(	const int *	sockfd,
		int *	flaRea,
		int *	nDblRea,
		int *	nIntRea,
		int *	nBooRea,
		double *	curSimTim,
		double	dblValRea[],
		int	intValRea[],
		int	booValRea[]
	)

Reads data from the socket.

Clients can call this method to exchange data through the socket.

Parameters

sockfd	Socket file descripter
flaRea	Communication flag read from the socket stream.
nDblRea	Number of double values to read.
nIntRea	Number of integer values to read.
nBooRea	Number of boolean values to read.
curSimTim	Current simulation time in seconds read from socket.
dblValRea	Double values read from socket.
intValRea	Integer values read from socket.
boolValRea	Boolean values read from socket.

See Also

int establishclientsocket(uint16_t *portNo)

Definition at line 899 of file util/utilSocket.c.

References disassembleBuffer(), f1, fprintf(), getRequiredReadBufferLength(), i, readbufferfromsocket(), REQUIRED_READ_LENGTH, and retVal.

Referenced by exchangewithsocket().

int save_append	(	char **	buffer,
		const char *	toAdd,
		int *	bufLen
	)

Appends a character array to another character array.

The array size of buffer may be extended by this function to prevent a buffer overflow. If realloc fails to allocate new memory, then this function calls perror(...) and returns EXIT_FAILURE.

Parameters

buffer	The buffer to which the character array will be added.
toAdd	The character array that will be appended to buffer
bufLen	The length of the character array buffer. This parameter will be set to the new size of buffer if memory was reallocated.

Returns

0 if no error occurred.

Definition at line 125 of file util/utilSocket.c.

References f1, and fprintf().

Referenced by assembleBuffer().

int sendclienterror	(	const int *	sockfd,
		const int *	flaWri
	)

Writes an error flag to the socket stream.

This method should be used by clients if they experience an error and need to terminate the socket connection.

Deprecated:

Use sendclientmessage instead

Parameters

sockfd	Socket file descripter
flaWri	should be set to a negative value.

Definition at line 322 of file util/utilSocket.h.

int sendclientmessage	(	const int *	sockfd,
		const int *	flaWri
	)

Writes a message flag to the socket stream.

This method should be used by clients if they need to send a flag to the BCVTB.

The flag flaWri is defined as follows: +1: simulation reached end time. -1: simulation terminates due to an (unspecified) error. -10: simulation terminates due to error during initialization. -20: simulation terminates due to error during time integration.

Parameters

sockfd	Socket file descripter
flaWri	Flag to be sent to the BCVTB

This method should be used by clients if they need to send a flag to the BCVTB.

The flag flaWri is defined as follows: +1: simulation reached end time. -1: simulation terminates due to an (unspecified) error. -10: simulation terminates due to error during initialization. -20: simulation terminates due to error during time integration.

Deprecated:

Use sendclientmessage instead

Parameters

sockfd	Socket file descripter
flaWri	Flag to be sent to the BCVTB

This method should be used by clients if they need to send a flag to the BCVTB.

The flag flaWri is defined as follows: +1: simulation reached end time. -1: simulation terminates due to an (unspecified) error. -10: simulation terminates due to error during initialization. -20: simulation terminates due to error during time integration.

Parameters

sockfd	Socket file descripter
flaWri	Flag to be sent to the BCVTB

Returns

Negative one.

Definition at line 785 of file util/utilSocket.c.

Referenced by sendclienterror().

int writetosocket	(	const int *	sockfd,
		const int *	flaWri,
		const int *	nDblWri,
		const int *	nIntWri,
		const int *	nBooWri,
		double *	curSimTim,
		double	dblValWri[],
		int	intValWri[],
		int	booValWri[]
	)

Writes data to the socket.

Clients can call this method to write data to the socket.

Parameters

sockfd	Socket file descripter
flaWri	Communication flag to write to the socket stream.
nDblWri	Number of double values to write.
nIntWri	Number of integer values to write.
nBooWri	Number of boolean values to write.
curSimTim	Current simulation time in seconds.
dblValWri	Double values to write.
intValWri	Integer values to write.
boolValWri	Boolean values to write.

See Also

int establishclientsocket(uint16_t *portNo)

Returns

The exit value of send, or a negative value if an error occured.

Definition at line 670 of file util/utilSocket.c.

References assembleBuffer(), f1, fprintf(), REQUIRED_WRITE_LENGTH, and retVal.

Referenced by exchangewithsocket(), and sendclientmessage().

Variable Documentation

FILE* f1 = NULL

Definition at line 136 of file util/utilSocket.h.

Referenced by disassembleBuffer(), establishclientsocket(), exchangewithsocket(), getsocketportnumber(), readbufferfromsocket(), readfromsocket(), save_append(), sendclientmessage(), and writetosocket().

int REQUIRED_READ_LENGTH = 0

Definition at line 138 of file util/utilSocket.h.

Referenced by establishclientsocket(), readbufferfromsocket(), readfromsocket(), and sendclientmessage().

int REQUIRED_WRITE_LENGTH = 0

Definition at line 139 of file util/utilSocket.h.

Referenced by establishclientsocket(), exchangewithsocket(), and writetosocket().

int SERVER_VERSION = 0

This will be overwritten to contain the version number of the server.

Definition at line 143 of file util/utilSocket.h.

Referenced by disassembleHeaderBuffer(), and readbufferfromsocket().