bsNull.h File Reference

BotSense bsProxy client library /dev/null interface. More...

#include "rnr/rnrconfig.h"
#include "botsense/BotSense.h"
#include "botsense/libBotSense.h"

Go to the source code of this file.

Macros
#define	BS_NULL_DEV_NAME   "/dev/null"
	DevNull device.
#define	BS_NULL_SERVER_MOD   "libbsserver_null"
	server plugin dll module
#define	BS_NULL_CLIENT_LIB   "libbsclient_null"
	client app library

Functions
const char *	bsNullGetMsgName (BsClient_P pClient, BsVConnHnd_T hndVConn, uint_t uMsgId)
	Get the DevNull message name. More...
int	bsNullReqOpen (BsClient_P pClient, bool_t bInitTrace)
	Request proxy server to establish a virtual connection to the /dev/null device. More...
int	bsNullReqClose (BsClient_P pClient, BsVConnHnd_T hndVConn)
	Request proxy server to close client's proxied DevNull device vitual connection. More...
int	bsNullReqWrite (BsClient_P pClient, BsVConnHnd_T hndVConn, byte_t wbuf[], size_t uWriteLen)
	Proxied request to write to /dev/null. More...

Detailed Description

BotSense bsProxy client library /dev/null interface.

LastChangedDate

2010-08-20 11:36:38 -0600 (Fri, 20 Aug 2010)

Rev

568

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

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

Definition in file bsNull.h.

Function Documentation

const char* bsNullGetMsgName	(	BsClient_P	pClient,
		BsVConnHnd_T	hndVConn,
		uint_t	uMsgId
	)

Get the DevNull message name.

For each (virtual connection, message id) 2-tuple, there can be a known name string (provided the id is valid and an application provides the information).

Parameters

pClient

Definition at line 100 of file bsNullClient.c.

References BsNullLookupMsgDef().

{
  const NMMsgDef_T  *pMsgDef;

  pMsgDef = BsNullLookupMsgDef((BsNullMsgId_T)uMsgId);

  return pMsgDef!=NULL? pMsgDef->m_sMsgName: "unknown";
}

int bsNullReqClose	(	BsClient_P	pClient,
		BsVConnHnd_T	hndVConn
	)

Request proxy server to close client's proxied DevNull device vitual connection.

Parameters

pClient

Definition at line 149 of file bsNullClient.c.

{
  return bsServerReqCloseDev(pClient, hndVConn);
}

int bsNullReqOpen	(	BsClient_P	pClient,
		bool_t	bInitTrace
	)

Request proxy server to establish a virtual connection to the /dev/null device.

Parameters

pClient

Definition at line 122 of file bsNullClient.c.

References BS_NULL_DEV_NAME, BS_NULL_SERVER_MOD, and BSCLIENT_TRY_ECODE.

{
  int     hnd;                      // vconn handle / return code

  //
  // Execute server transaction (returns handle \h_ge 0 on success).
  //
  hnd = bsServerReqOpenDev(pClient, BS_NULL_DEV_NAME, BS_NULL_SERVER_MOD,
                          NULL, (size_t)0, &bsNullAppInfo, bInitTrace);

  // check transaction return code
  BSCLIENT_TRY_ECODE(pClient, hnd, "bsServerReqOpenDev(dev='%s') failed.",
                      BS_NULL_DEV_NAME);

  // return handle
  return hnd;
}

int bsNullReqWrite	(	BsClient_P	pClient,
		BsVConnHnd_T	hndVConn,
		byte_t	wbuf[],
		size_t	uWriteLen
	)

Proxied request to write to /dev/null.

Parameters

pClient

Definition at line 166 of file bsNullClient.c.

References BS_ECODE_BAD_VAL, BSCLIENT_HAS_VCONN, BSCLIENT_TRY_ECODE, BSCLIENT_TRY_EXPR, BSCLIENT_TRY_NM_ECODE, BSNULL_REQWRITE_WRITEBUF_LEN, BsNullMsgIdReqWrite, BsNullMsgIdRspWrite, BsNullPackReqWrite(), BsNullUnpackRspWrite(), BSPROXY_BUF_BODY, BSPROXY_MSG_MAX_LEN, BsNullRspWrite_T::m_byteswritten, BsNullReqWrite_T::m_count, BsNullReqWrite_T::m_writebuf, and BsNullReqWrite_T::u.

{
  static BsNullMsgId_T  msgIdReq = BsNullMsgIdReqWrite;
  static BsNullMsgId_T  msgIdRsp = BsNullMsgIdRspWrite;

  BsNullReqWrite_T  msgReq;                   // request message 
  BsNullRspWrite_T  msgRsp;                   // response message 
  byte_t            buf[BSPROXY_MSG_MAX_LEN]; // req/rsp buffer
  bool_t            bTrace;                   // do [not] trace messages
  int               n;                        // number of bytes/return code

  //
  // Parameter checks.
  //
  BSCLIENT_TRY_EXPR(pClient, BSCLIENT_HAS_VCONN(pClient, hndVConn),
      BS_ECODE_BAD_VAL, "VConn=%d", hndVConn);

  BSCLIENT_TRY_EXPR(pClient,
      (uWriteLen <= (size_t)BSNULL_REQWRITE_WRITEBUF_LEN), BS_ECODE_BAD_VAL,
      "write_len=%zu > max_len=%zu",
      uWriteLen, (size_t)BSNULL_REQWRITE_WRITEBUF_LEN);

  // trace state
  bTrace = bsClientAttrGetTraceState(pClient, hndVConn);

  //
  // Set request message values.
  //
  memcpy(msgReq.m_writebuf.u.m_buf, wbuf, uWriteLen);
  msgReq.m_writebuf.m_count = uWriteLen;

  //
  // Pack request.
  //
  n = BsNullPackReqWrite(&msgReq, BSPROXY_BUF_BODY(buf), bTrace);

  // check packing return code
  BSCLIENT_TRY_NM_ECODE(pClient, n, "MsgId=%u", msgIdReq);

  //
  // Execute request-response transaction.
  //
  n = bsClientTrans(pClient,  hndVConn,
                    msgIdReq, buf, (size_t)n,
                    msgIdRsp, buf, sizeof(buf));

  // check transaction return code
  BSCLIENT_TRY_ECODE(pClient, n, "MsgId=%u: Transaction failed.", msgIdReq);

  //
  // Unpack response.
  //
  n = BsNullUnpackRspWrite(buf, (size_t)n, &msgRsp, bTrace);

  // check unpack return code
  BSCLIENT_TRY_NM_ECODE(pClient, n, "MsgId=%u", msgIdRsp);

  //
  // Set return values from response.
  //
  return (int)msgRsp.m_byteswritten;
}