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

namespace LLRP
{

/*
 * @brief   Forward class declaration of platform-specific socket wrapper
 *
 * The definition is in ltkcpp_connection.cpp.
 *
 * On Linux a socket is a simple type (int). On Windows it
 * is a pointer to a specific type defined in a WinSock
 * header (.h) file. Rather than make that header file a
 * prerequisite to every source file that includes this header
 * file (ltkcpp_connection.h), the following CPlatformSocket
 * class opaquely wraps the platform-specific socket.
 *
 * The CConnection class references it by pointer only.
 * The content of the CPlatformSocket is only known
 * within the implementation of CConnection.
 */
class CPlatformSocket;

class CConnection
{
  public:
    CConnection (
      const CTypeRegistry *     pTypeRegistry,
      unsigned int              nBufferSize);

    ~CConnection (void);

    int
    openConnectionToReader (
      const char *              pReaderHostName);

    const char *
    getConnectError (void);

    int
    closeConnectionToReader (void);

    CMessage *
    transact (
      CMessage *                pSendMessage,
      int                       nMaxMS);

    const CErrorDetails *
    getTransactError (void);

    EResultCode
    sendMessage (
      CMessage *                pMessage);

    const CErrorDetails *
    getSendError (void);

    CMessage *
    recvMessage (
      int                       nMaxMS);

    CMessage *
    recvResponse (
      int                       nMaxMS,
      const CTypeDescriptor *   pResponseType,
      llrp_u32_t                ResponseMessageID);

    const CErrorDetails *
    getRecvError (void);

  private:
    CPlatformSocket *           m_pPlatformSocket;

    const char *                m_pConnectErrorStr;

    const CTypeRegistry *       m_pTypeRegistry;

    std::list<CMessage *>       m_listInputQueue;

    unsigned int                m_nBufferSize;

    struct RecvState
    {
        llrp_byte_t *       pBuffer;

        unsigned int        nBuffer;

        int                 bFrameValid;

        CFrameExtract       FrameExtract;

        CErrorDetails       ErrorDetails;
    }                           m_Recv;

    struct SendState
    {
        llrp_byte_t *       pBuffer;

        unsigned int        nBuffer;

        CErrorDetails       ErrorDetails;
    }                           m_Send;

  private:
    EResultCode
    recvAdvance (
      int                           nMaxMS,
      time_t                        timeLimit);

    time_t
    calculateTimeLimit (
      int                           nMaxMS);
};


}; /* namespace LLRP */

---