util/utilSocket.h

Go to the documentation of this file.

// Methods for interfacing clients using BSD sockets.

/*
********************************************************************
Copyright Notice
----------------

Building Controls Virtual Test Bed (BCVTB) Copyright (c) 2008-2009, The
Regents of the University of California, through Lawrence Berkeley
National Laboratory (subject to receipt of any required approvals from
the U.S. Dept. of Energy). All rights reserved.

If you have questions about your rights to use or distribute this
software, please contact Berkeley Lab's Technology Transfer Department
at TTD@lbl.gov

NOTICE.  This software was developed under partial funding from the U.S.
Department of Energy.  As such, the U.S. Government has been granted for
itself and others acting on its behalf a paid-up, nonexclusive,
irrevocable, worldwide license in the Software to reproduce, prepare
derivative works, and perform publicly and display publicly.  Beginning
five (5) years after the date permission to assert copyright is obtained
from the U.S. Department of Energy, and subject to any subsequent five
(5) year renewals, the U.S. Government is granted for itself and others
acting on its behalf a paid-up, nonexclusive, irrevocable, worldwide
license in the Software to reproduce, prepare derivative works,
distribute copies to the public, perform publicly and display publicly,
and to permit others to do so.


Modified BSD License agreement
------------------------------

Building Controls Virtual Test Bed (BCVTB) Copyright (c) 2008-2009, The
Regents of the University of California, through Lawrence Berkeley
National Laboratory (subject to receipt of any required approvals from
the U.S. Dept. of Energy).  All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

   1. Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
   2. Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in
      the documentation and/or other materials provided with the
      distribution.
   3. Neither the name of the University of California, Lawrence
      Berkeley National Laboratory, U.S. Dept. of Energy nor the names
      of its contributors may be used to endorse or promote products
      derived from this software without specific prior written permission. 

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

You are under no obligation whatsoever to provide any bug fixes,
patches, or upgrades to the features, functionality or performance of
the source code ("Enhancements") to anyone; however, if you choose to
make your Enhancements available either publicly, or directly to
Lawrence Berkeley National Laboratory, without imposing a separate
written license agreement for such Enhancements, then you hereby grant
the following license: a non-exclusive, royalty-free perpetual license
to install, use, modify, prepare derivative works, incorporate into
other computer software, distribute, and sublicense such enhancements or
derivative works thereof, in binary and source code form.

********************************************************************
*/

#ifndef _UTILSOCKET_H_
#define _UTILSOCKET_H_
#ifdef _MSC_VER // Microsoft compiler
#include <windows.h>
#include <winsock.h>

//#include <winsock2.h>
//#include <ws2tcpip.h> // this gives compile error due to bug in .h file
#else
// Include arpa/inet.h so that inet_ntoa is defined for 64bit linux
// and on Mac OS X 10.6.1 Snow Leopard
#include <arpa/inet.h>
#include <sys/socket.h>
//#include <netinet/in.h>
#include <netdb.h> 
#endif

#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"

FILE *f1 = NULL; 
#define HEADER_LENGTH 54 // =10 + 4*(10+1);
int REQUIRED_READ_LENGTH  = 0;
int REQUIRED_WRITE_LENGTH = 0;

int SERVER_VERSION = 0; 

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

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

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

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


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

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

int getsocketportnumber(const char *const docname);

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

int getmainversionnumber();

int establishclientsocket(const char *const docname);

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[]);


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

int sendclienterror(const int *sockfd, const int *flaWri){
    return sendclientmessage(sockfd, flaWri);
}

int getRequiredReadBufferLength(const int *sockfd);

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

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

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

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[]);

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

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);


int closeipc(int* sockfd);

#endif /* _UTILSOCKET_H_ */