termsender.h

Go to the documentation of this file.

/*
 * 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
 */

#ifndef TERMSENDER_H
#define TERMSENDER_H

#include "libicl.h"
#include "glib.h"

#ifdef __cplusplus
extern "C" {
#endif

  struct TermSenderStruct;
  typedef struct TermSenderStruct TermSender;

  typedef void (*TermSenderSendTerm)(TermSender*, ICLTerm*);
  typedef void (*TermSenderCleanup)(TermSender*);

  enum TermSenderTypeEnum {
    UNKNOWNTERMSENDERTYPE = -1,
    STRINGTERMSENDERTYPE = 0,
    BINARYTERMSENDERTYPE = 1
  }
  ;
  typedef enum TermSenderTypeEnum TermSenderType;

  enum TermSenderErrorNum {
    TERMSENDER_BININVALIDELEMENT = -102,
    TERMSENDER_BINUNKNOWNTYPETWICE = -101,
    TERMSENDER_BINUNKNOWNTYPEONCE = -100,
    TERMSENDER_BADTRANSLATION = -4,
    TERMSENDER_NOTINITIALIZED = -3,
    TERMSENDER_BADSEND = -2,
    TERMSENDER_NULLTOSEND = -1,
    TERMSENDER_OKAY = 0
  }
  ;

  EXTERN TermSender* termSender_create();
  EXTERN void termSender_free(TermSender* t);
  EXTERN int termSender_sendTerm(TermSender* sender, ICLTerm* term);

  EXTERN void termSender_setError(TermSender* t, gint errnum);
  EXTERN gint termSender_getError(TermSender* t);
  EXTERN void termSender_setSocket(TermSender* t, gint newsocket);
  EXTERN gint termSender_getSocket(TermSender* t);
  EXTERN void termSender_setType(TermSender* t, TermSenderType type);
  EXTERN TermSenderType termSender_getType(TermSender* t);
  EXTERN void termSender_setSenderSpecificData(TermSender* t, gpointer g);
  EXTERN gpointer termSender_getSenderSpecificData(TermSender* t);
  EXTERN void termSender_setSendTermCallback(TermSender* t, TermSenderSendTerm s);
  EXTERN void termSender_setCleanupCallback(TermSender* t, TermSenderCleanup c);

#ifdef __cplusplus
}
#endif

#endif

---