libcom_tcp.h

Go to the documentation of this file.

/******************************************************************************
%   File    : libcom_tcp.h
%*/
/*
 * Copyright (C) 2006  SRI International
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * SRI International: 333 Ravenswood Ave, Menlo Park, CA 94025
 */


/* Make sure only loaded once... */
#ifndef _LIBCOMTCP_H_INCLUDED
#define _LIBCOMTCP_H_INCLUDED

#ifdef __cplusplus
extern "C" {
#endif

#ifdef IS_DLL
#define EXTERN __declspec(dllexport)
#else
#define EXTERN extern
#endif

#ifndef MAX
#define MAX(a,b) ((a) > (b) ? (a) : (b))
#endif

  /* Requires libicl.h */
#include "libicl.h"

#ifndef _WINDOWS
  typedef int SOCKET;
#else
#include <winsock.h>
#endif

  EXTERN SOCKET com_Connect(char *ConnectionId, ICLTerm *Address);
  EXTERN SOCKET comConnectFormat(char* ConnectionId, ICLTerm* Params,
                               ICLTerm* Address, int format);
  EXTERN int  com_Disconnect(char *ConnectionId);
  EXTERN int  com_ListenAt(char *ConnectionId, ICLTerm *Params, ICLTerm *Address);
  EXTERN int  com_SendData(char *ConnectionId, char *Data, int size);
  EXTERN int  com_SendTerm(char *ConnectionId, ICLTerm* term);
  EXTERN int  com_Select(char *ConnectionId, double TimeOut);
  EXTERN int  com_AddInfo(char *ConnectionId, ICLTerm *NewInfo);
  EXTERN int  com_UpdateInfo(char *ConnectionId, ICLTerm *NewInfo);
  EXTERN int  com_RemoveInfo(char *ConnectionId, ICLTerm *NewInfo);
  EXTERN int  com_GetInfo(char *ConnectionId, ICLTerm *GInfo,
                            ICLTerm **Result);
  EXTERN int      com_GetConnectionFromInfo(ICLTerm *Info, char** connectionName);

  EXTERN SOCKET com_Connected(char* ConnectionId);
  EXTERN int      com_GetAllValidConnections(ICLTerm** result);

  EXTERN int  com_GetConnectionId(char **ConnectionId, ICLTerm *GInfo);
  EXTERN char *com_GetDefaultConnectionId();
  EXTERN int com_SelectEvent(char* ConnectionId, double timeout, ICLTerm **event);

  EXTERN void cnx_CanonicalAddress(ICLTerm *address, SOCKET socket, ICLTerm **result);

  EXTERN int COM_BEST_FORMAT;
  EXTERN int COM_STRING_FORMAT;
  EXTERN int COM_BINARY_FORMAT;

  EXTERN int com_GetEventFromConnection(char *ConnectionId, double timeout, ICLTerm **event);
  EXTERN int com_SelectEventFromAllIds(double timeout, ICLTerm **event);

#ifdef __cplusplus
}
#endif

#endif

---