nrtb-core team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 19
committer: fpstovall@xxxxxxxxx
branch nick: dev
timestamp: Wed 2010-12-29 21:21:26 -0500
message:
  First cut at the complete transciever interface (header file). Also updated the make file to build any missing dependencies.
modified:
  common/transciever/Makefile
  common/transciever/transciever.h


--
lp:~fpstovall/nrtb/cpp_common
https://code.launchpad.net/~fpstovall/nrtb/cpp_common

Your team NRTB Core is subscribed to branch lp:~fpstovall/nrtb/cpp_common.
To unsubscribe from this branch go to https://code.launchpad.net/~fpstovall/nrtb/cpp_common/+edit-subscription

=== modified file 'common/transciever/Makefile'
--- common/transciever/Makefile	2010-12-29 16:30:53 +0000
+++ common/transciever/Makefile	2010-12-30 02:21:26 +0000
@@ -21,7 +21,10 @@
 	@cp -v transciever.o ../obj
 	@echo build complete
 
-transciever.o:	transciever.h transciever.cpp Makefile
+../include/confreader.h:
+	@cp ../confreader; make lib
+
+transciever.o:	transciever.h transciever.cpp Makefile ../include/confreader.h
 	@rm -f transciever.o
 	g++ -c transciever.cpp -I ../include
 

=== modified file 'common/transciever/transciever.h'
--- common/transciever/transciever.h	2010-12-29 16:30:53 +0000
+++ common/transciever/transciever.h	2010-12-30 02:21:26 +0000
@@ -22,25 +22,92 @@
 #include <string>
 #include <Poco/Net/StreamSocket.h>
 #include <Poco/Net/SocketStream.h>
+#include <Poco/Logger.h>
+#include <Poco/Exception.h>
 #include <boost/circular_buffer.hpp>
 
 namespace nrtb
 {
+  /*******************************************************************
+   * transciever is used to manage GBP (google protocol buffers)
+   * traffic between NRTB components. This is the only form of 
+   * IPC used by NRTB.
+   * 
+   * out_gpb is the channel wrapper for the outbound channel.
+   * in_gpb is the channel wrapper for the inbound channel.
+   * 
+   * See https://blueprints.launchpad.net/nrtb/+spec/icp-spec for
+   * specification this class implements.
+   * ***************************************************************/
   template <class out_gpb, class in_gpb>
   class transciever
   {
 	public:
+	  /// outbound messages will be of this type
 	  typedef out_gpb outbound_type;
+	  /// inbound messages will be of this type.
 	  typedef in_gpb inbound_type;
+	  /**************************************************************
+	   * Creates the transciever and associates it with a provided 
+	   * socket. Once created this class assumes it uniquely owns the 
+	   * socket and will close it upon distruction.
+	   * ***********************************************************/
 	  transciever(Poco::Net::StreamSocket socket);
+	  /**************************************************************
+	   * Closes the socket and releases all mmemory associated with
+	   * this class.
+	   * ***********************************************************/
 	  ~transciever();
+	  /**************************************************************
+	   * gets the next message from the socket. If no messages are 
+	   * ready, blocks util one arrives. 
+	   * ***********************************************************/
 	  inbound_type & get();
-	  void send(const & outbound_type);
+	  /**************************************************************
+	   * Sends a message over the socket and adds it to the 
+	   * sent_messages buffer in case it's needed for error recovery.
+	   * ***********************************************************/
+	  void send(outbound_type & sendme);
+	  /**************************************************************
+	   * Called by the data consumer when an inbound message was 
+	   * not valid in the current application context. msg_number
+	   * is the sequence number of the offending message.
+	   * ***********************************************************/
+	  void nak_invalid_context(const unsigned long int msg_number);
+	  /**************************************************************
+	   * Called by the data consumer when an inbound message's 
+	   * data failed validation checks. msg_number is the sequence
+	   * number of the offending message.
+	   * ***********************************************************/
+	  void nak_validation_error(const unsigned long int msg_number);
+	  /**************************************************************
+	   * Exceptions which may be thrown for external resulution.
+	   * ***********************************************************/
+	  // parent of all transciever exceptions
+	  POCO_DECLARE_EXCEPTION(transciever, general_exception, Poco::Exception)
+	  // thrown if send fails due to timeout.
+	  POCO_DECLARE_EXCEPTION(transciever, send_timeout, general_exception)
+	  // thrown in the case of a fault while in get()
+	  POCO_DECLARE_EXCEPTION(transciever, get_fault, general_exception)
+	  // Thrown if the socket is closed due to an unrecoverable date error.
+	  POCO_DECLARE_EXCEPTION(transciever, unrecoverable_data_error, general_exception)
+	  // Thrown if the socket is closed due to too many errors in a row
+	  POCO_DECLARE_EXCEPTION(transciever, consecutive_error_overrun, general_exception)
 	protected:
+	  // pointer to this class's logger instance
+	  Poco::Logger * log;
+	  // The socket used for communcation.
 	  Poco::Net::StreamSocket sock;
+	  // the associated iostream (Do we need this?)
 	  Poco::Net::SocketStream stream;
+	  // buffer to hold previously sent messages; required for 
+	  // error recovery.
 	  boost::circular_buffer<outbound_type> sent_messages;
-	private:
+	  // fence post for recovery efforts, zero if none in play
+	  unsigned long long nak_fence_post;
+	  // These methods implment actual nak recovery.
+	  void handle_inbound_nak();
+	  void handle_outbound_nak();
   };
 
 } // namespace nrtb