ltkc_connection.h

Go to the documentation of this file.

/*
 ***************************************************************************
 *  Copyright 2007,2008 Impinj, Inc.
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 ***************************************************************************
 */

/* Forward type declarations */
struct LLRP_SConnection;
typedef struct LLRP_SConnection     LLRP_tSConnection;


struct LLRP_SConnection
{
    int                         fd;

    const char *                pConnectErrorStr;

    const LLRP_tSTypeRegistry * pTypeRegistry;

    LLRP_tSMessage *            pInputQueue;

    unsigned int                nBufferSize;

    struct
    {
        unsigned char *     pBuffer;

        unsigned int        nBuffer;

        int                 bFrameValid;

        LLRP_tSFrameExtract FrameExtract;

        LLRP_tSErrorDetails ErrorDetails;
    }                           Recv;

    struct
    {
        unsigned char *     pBuffer;

        unsigned int        nBuffer;

        LLRP_tSErrorDetails ErrorDetails;
    }                           Send;
};




/*
 * ltkc_connection.c
 */
extern LLRP_tSConnection *
LLRP_Conn_construct (
  const LLRP_tSTypeRegistry *   pTypeRegistry,
  unsigned int                  nBufferSize);

extern void
LLRP_Conn_destruct (
  LLRP_tSConnection *           pConn);

extern int
LLRP_Conn_openConnectionToReader (
  LLRP_tSConnection *           pConn,
  const char *                  pReaderHostName);

extern int
LLRP_Conn_closeConnectionToReader (
  LLRP_tSConnection *           pConn);

extern const char *
LLRP_Conn_getConnectError (
  LLRP_tSConnection *           pConn);

extern LLRP_tSMessage *
LLRP_Conn_transact (
  LLRP_tSConnection *           pConn,
  LLRP_tSMessage *              pSendMessage,
  int                           nMaxMS);

extern const LLRP_tSErrorDetails *
LLRP_Conn_getTransactError (
  LLRP_tSConnection *           pConn);

extern LLRP_tResultCode
LLRP_Conn_sendMessage (
  LLRP_tSConnection *           pConn,
  LLRP_tSMessage *              pMessage);

extern const LLRP_tSErrorDetails *
LLRP_Conn_getSendError (
  LLRP_tSConnection *           pConn);

extern LLRP_tSMessage *
LLRP_Conn_recvMessage (
  LLRP_tSConnection *           pConn,
  int                           nMaxMS);

extern LLRP_tSMessage *
LLRP_Conn_recvResponse (
  LLRP_tSConnection *           pConn,
  int                           nMaxMS,
  const LLRP_tSTypeDescriptor * pResponseType,
  llrp_u32_t                    ResponseMessageID);

extern const LLRP_tSErrorDetails *
LLRP_Conn_getRecvError (
  LLRP_tSConnection *           pConn);