bsLibInternal.h File Reference

The libBotSense internal declarations. More...

#include <errno.h>
#include <pthread.h>
#include "rnr/rnrconfig.h"
#include "rnr/sock.h"
#include "botsense/BotSense.h"
#include "botsense/libBotSense.h"

Go to the source code of this file.

Classes
struct	BsTransInfo_T
	Cashed Transaction Information Structure. More...
struct	BsVConn_T
	Client Virtual Connection Info Structure. More...
struct	_bsClientStruct
	The Client Structure Type. More...

Macros
#define	BSCLIENT_T_READ   10000000
	10 second read timeout default
#define	BSCLIENT_T_WRITE   5000000
	5 second write timeout default
#define	BSCLIENT_T_FLUSH   5000000
	5 second flush timeout default
#define	_BS_LOG_MSGHDR(pClient, sPreface, pMsgHdr)
	Log [pre/un]packed message header. More...
#define	_BS_LOG_REQ(pClient, pMsgHdr)
	Log successful request recieved event. More...
#define	_BS_LOG_RSP(pClient, pMsgHdr)
	Log successful repsonse recieved event. More...

Typedefs
typedef struct _bsClientStruct	BsClient_T
	The Client Structure Type.

Functions
INLINE_IN_H BsVConn_T *	bsGetVConn (BsClient_T *pClient, BsVConnHnd_T hndVConn)
void	bsVConnClearAll (BsClient_T *pClient)
	Remove and delete all of a client's vConnections. More...
int	bsVConnAdd (BsClient_T *pClient, BsVConnHnd_T hndVConn, int index)
	Add a created vConnection to the client's tblHndIndex table. More...
int	bsVConnRemove (BsClient_T *pClient, BsVConnHnd_T hndVConn)
	Remove a vConnection from the client's tblHndIndex table. More...
int	bsVConnNew (BsClient_T *pClient, const char *sDevName, const char *sModName, const BsClientAppInfo_T *pAppInfo, bool_t bTrace)
	Reserve a new client vConnection (and proxied device) in the client's tblVConn table. More...
int	bsVConnDelete (BsClient_T *pClient, int index)
	Delete a vConnection (and proxied device) from the client's tblVConn table. More...

Detailed Description

The libBotSense internal declarations.

LastChangedDate

2012-11-25 10:42:41 -0700 (Sun, 25 Nov 2012)

Rev

2544

Author

Robin Knight (robin.nosp@m..kni.nosp@m.ght@r.nosp@m.oadn.nosp@m.arrow.nosp@m.s.co.nosp@m.m)

Copyright

© 2009-2017. RoadNarrows LLC.
http://www.roadnarrows.com
All Rights Reserved

Definition in file bsLibInternal.h.

Macro Definition Documentation

#define _BS_LOG_MSGHDR	(		pClient,
			sPreface,
			pMsgHdr
	)

Value:

do \
  { \
    if( LOGABLE(LOG_LEVEL_DIAG3) ) \
    { \
      bsClientLogMsgHdr(pClient, sPreface, pMsgHdr); \
    } \
  } while(0)

Log [pre/un]packed message header.

Parameters

pClient

Definition at line 127 of file bsLibInternal.h.

Referenced by bsClientRecvRsp(), and bsClientSendReq().

#define _BS_LOG_REQ	(		pClient,
			pMsgHdr
	)

Value:

LOGDIAG3("%s: MsgId=%d sent.", \
      bsClientAttrGetName(pClient), (pMsgHdr)->m_hdrMsgId)

Log successful request recieved event.

Parameters

pClient

Definition at line 145 of file bsLibInternal.h.

Referenced by bsClientTrans().

#define _BS_LOG_RSP	(		pClient,
			pMsgHdr
	)

Value:

LOGDIAG3("%s: MsgId=%d received.", \
      bsClientAttrGetName(pClient), (pMsgHdr)->m_hdrMsgId)

Log successful repsonse recieved event.

Parameters

pClient

Definition at line 155 of file bsLibInternal.h.

Referenced by bsClientTrans().

Function Documentation

INLINE_IN_H BsVConn_T* bsGetVConn	(	BsClient_T *	pClient,
		BsVConnHnd_T	hndVConn
	)

Get the client vConnection given the handle.

Parameters

pClient

Definition at line 172 of file bsLibInternal.h.

References BSCLIENT_IS_VCONN_HANDLE, BSPROXY_VCONN_UNDEF, bsVConnAdd(), bsVConnClearAll(), bsVConnDelete(), bsVConnNew(), bsVConnRemove(), _bsClientStruct::m_tblHndIndex, and _bsClientStruct::m_tblVConn.

Referenced by bsClientAttrGetTraceState(), and bsClientGetMsgName().

{
  if( BSCLIENT_IS_VCONN_HANDLE(hndVConn) && 
      (pClient->m_tblHndIndex[hndVConn] != BSPROXY_VCONN_UNDEF) )
  {
    return pClient->m_tblVConn[pClient->m_tblHndIndex[hndVConn]];
  }
  else
  {
    return NULL;
  }
}

int bsVConnAdd	(	BsClient_T *	pClient,
		BsVConnHnd_T	hndVConn,
		int	index
	)

Add a created vConnection to the client's tblHndIndex table.

Note

The new vConnection should have been created and reserved prior to adding.

Parameters

pClient

Definition at line 1506 of file bsLibClient.c.

References BS_ECODE_INTERNAL, BS_OK, BSCLIENT_IS_VCONN_HANDLE, BSCLIENT_LOG_ERROR, BSCLIENT_TRY_EXPR, BSPROXY_VCONN_CLIENT_MAX, BSPROXY_VCONN_UNDEF, bsTransLock(), bsTransUnlock(), BsVConn_T::m_hndVConn, _bsClientStruct::m_nVConnCount, _bsClientStruct::m_tblHndIndex, and _bsClientStruct::m_tblVConn.

Referenced by bsGetVConn(), and bsServerReqOpenDev().

{
  int   i;
  int   rc;

  BSCLIENT_TRY_EXPR(pClient, BSCLIENT_IS_VCONN_HANDLE(hndVConn),
      BS_ECODE_INTERNAL, "VConn=%d: out-of-range.", hndVConn);

  BSCLIENT_TRY_EXPR(pClient, (index < BSPROXY_VCONN_CLIENT_MAX),
      BS_ECODE_INTERNAL, "index=%d: out-of-range.", index);

  bsTransLock(pClient);

  i = (int)pClient->m_tblHndIndex[hndVConn];

  if( i != BSPROXY_VCONN_UNDEF )
  {
    BSCLIENT_LOG_ERROR(pClient, BS_ECODE_INTERNAL,
      "VConn=%d: index=%d: handle already assigned: "
      "Internal vconn tables corrupted.", hndVConn, i);
    rc = -BS_ECODE_INTERNAL;
  }

  else if( pClient->m_tblVConn[index] == NULL )
  {
    BSCLIENT_LOG_ERROR(pClient, BS_ECODE_INTERNAL,
      "VConn=%d: index=%d: No vConnection present: "
      "Internal vconn tables corrupted.", hndVConn, index);
    rc = -BS_ECODE_INTERNAL;
  }

  else
  {
    pClient->m_tblVConn[index]->m_hndVConn = hndVConn;
    pClient->m_tblHndIndex[hndVConn] = (byte_t)index;
    pClient->m_nVConnCount++;
    rc = BS_OK;
  }

  bsTransUnlock(pClient);

  return rc;
}

void bsVConnClearAll

(

BsClient_T *

pClient

)

Remove and delete all of a client's vConnections.

Parameters

pClient

Definition at line 1478 of file bsLibClient.c.

References BSPROXY_VCONN_UNDEF, bsVConnDelete(), bsVConnRemove(), and _bsClientStruct::m_tblHndIndex.

Referenced by bsClientDelete(), bsGetVConn(), and bsServerDisconnect().

{
  size_t  nHnd;
  int     index;

  for(nHnd=0; nHnd<arraysize(pClient->m_tblHndIndex); ++nHnd)
  {
    index = (int)pClient->m_tblHndIndex[nHnd];
    if( index != BSPROXY_VCONN_UNDEF )
    {
      bsVConnRemove(pClient, (BsVConnHnd_T)nHnd);
      bsVConnDelete(pClient, index);
    }
  }
}

int bsVConnDelete	(	BsClient_T *	pClient,
		int	index
	)

Delete a vConnection (and proxied device) from the client's tblVConn table.

Note

The vConnection should be removed first prior to deletion.

Parameters

pClient

Definition at line 1684 of file bsLibClient.c.

References BS_ECODE_INTERNAL, BS_OK, BSCLIENT_LOG_ERROR, BSCLIENT_TRY_EXPR, BSPROXY_VCONN_CLIENT_MAX, bsTransLock(), bsTransUnlock(), BsVConn_T::m_sDevName, BsVConn_T::m_sModName, and _bsClientStruct::m_tblVConn.

Referenced by bsGetVConn(), bsServerReqCloseDev(), bsServerReqOpenDev(), and bsVConnClearAll().

{
  BsVConn_T  *pVConn;
  int         rc;

  BSCLIENT_TRY_EXPR(pClient, (index < BSPROXY_VCONN_CLIENT_MAX),
      BS_ECODE_INTERNAL, "index=%d: out-of-range.", index);

  bsTransLock(pClient);

  pVConn = pClient->m_tblVConn[index];

  if( pVConn == NULL )
  {
    BSCLIENT_LOG_ERROR(pClient, BS_ECODE_INTERNAL,
      "index=%u: vConnection not present in table.", index);
    rc = -BS_ECODE_INTERNAL;
  }

  else
  {
    delete((char *)(pVConn->m_sDevName));
    delete((char *)(pVConn->m_sModName));
    delete(pVConn);

    // free slot
    pClient->m_tblVConn[index] = NULL;

    rc = BS_OK;
  }

  bsTransUnlock(pClient);

  return rc;
}

int bsVConnNew	(	BsClient_T *	pClient,
		const char *	sDevName,
		const char *	sModName,
		const BsClientAppInfo_T *	pAppInfo,
		bool_t	bTrace
	)

Reserve a new client vConnection (and proxied device) in the client's tblVConn table.

Note

The new vConnection still needs to be added.

Parameters

pClient

Definition at line 1614 of file bsLibClient.c.

References BS_ECODE_INTERNAL, BS_ECODE_NO_RSRC, BS_OK, BSCLIENT_LOG_ERROR, bsClientAttrGetVConnCount(), BSPROXY_VCONN_CLIENT_MAX, BSPROXY_VCONN_UNDEF, bsTransLock(), bsTransUnlock(), BsVConn_T::m_bTrace, BsVConn_T::m_hndVConn, BsVConn_T::m_pAppInfo, BsVConn_T::m_sDevName, BsVConn_T::m_sModName, and _bsClientStruct::m_tblVConn.

Referenced by bsGetVConn(), and bsServerReqOpenDev().

{
  int         index;
  BsVConn_T  *pVConn;
  int         rc = BS_OK;

  bsTransLock(pClient);

  if( bsClientAttrGetVConnCount(pClient) >= BSPROXY_VCONN_CLIENT_MAX )
  {
    BSCLIENT_LOG_ERROR(pClient, BS_ECODE_NO_RSRC,
        "Client has the maximum=%d virtual connections.",
        BSPROXY_VCONN_CLIENT_MAX);
    rc = -BS_ECODE_NO_RSRC;
  }

  else
  {
    for(index=0; index<BSPROXY_VCONN_CLIENT_MAX; ++index)
    {
      if( pClient->m_tblVConn[index] == NULL )
      {
        break;
      }
    }

    if( index >= BSPROXY_VCONN_CLIENT_MAX )
    {
      BSCLIENT_LOG_ERROR(pClient, BS_ECODE_INTERNAL,
                      "Internal vconn tables corrupted.");
      rc = -BS_ECODE_INTERNAL;
    }
  }

  if( rc == BS_OK )
  {
    pVConn = NEW(BsVConn_T);

    pVConn->m_hndVConn  = BSPROXY_VCONN_UNDEF;
    pVConn->m_bTrace    = bTrace;
    pVConn->m_sDevName  = new_strdup(sDevName);
    pVConn->m_sModName  = new_strdup(sModName);
    pVConn->m_pAppInfo  = pAppInfo;

    // reserve slot
    pClient->m_tblVConn[index] = pVConn;
    
    rc = index;
  }

  bsTransUnlock(pClient);

  return rc;
}

int bsVConnRemove	(	BsClient_T *	pClient,
		BsVConnHnd_T	hndVConn
	)

Remove a vConnection from the client's tblHndIndex table.

Note

The vConnection stills needs to be deleted.

Parameters

pClient

Definition at line 1565 of file bsLibClient.c.

References BS_ECODE_INTERNAL, BSCLIENT_IS_VCONN_HANDLE, BSCLIENT_LOG_ERROR, BSCLIENT_TRY_EXPR, BSPROXY_VCONN_UNDEF, bsTransLock(), bsTransUnlock(), BsVConn_T::m_hndVConn, _bsClientStruct::m_nVConnCount, _bsClientStruct::m_tblHndIndex, and _bsClientStruct::m_tblVConn.

Referenced by bsGetVConn(), bsServerReqCloseDev(), and bsVConnClearAll().

{
  int   index;
  int   rc;

  BSCLIENT_TRY_EXPR(pClient, BSCLIENT_IS_VCONN_HANDLE(hndVConn),
      BS_ECODE_INTERNAL, "VConn=%d: out-of-range.", hndVConn);

  bsTransLock(pClient);

  index = pClient->m_tblHndIndex[hndVConn];

  if( index == BSPROXY_VCONN_UNDEF )
  {
    BSCLIENT_LOG_ERROR(pClient, BS_ECODE_INTERNAL,
      "VConn=%d: vConnection not present in table.", hndVConn);
    rc = -BS_ECODE_INTERNAL;
  }

  else
  {
    pClient->m_tblVConn[index]->m_hndVConn = BSPROXY_VCONN_UNDEF;
    pClient->m_tblHndIndex[hndVConn] = BSPROXY_VCONN_UNDEF;
    pClient->m_nVConnCount--;

    rc = index;
  }

  bsTransUnlock(pClient);

  return rc;
}