added bibliography to tex file and small changes

doc/tech_report.tex

@@ -8,7 +8,7 @@
 \begin{document}
 \title{Labcomm tech report}
 \author{Anders Blomdell and Sven Gesteg\aa{}rd Robertz }
-\date{embryo of draft, \today}
+\date{draft, \today}
 
 \maketitle
 
@@ -43,7 +43,7 @@ that is similar to C or Java type-declarations.
 %[[http://asn1.org|ASN1]].
 
 LabComm has got it's inspiration from Sun RPC~\cite{SunRPC}
-and ASN1~\cite{ANS1}. LabComm is primarily intended for situations
+and ASN1~\cite{ASN1}. LabComm is primarily intended for situations
 where the overhead of communication has to be kept at a minimum, hence LabComm
 only requires one-way communication to operate. The one-way operation also has
 the added benefit of making LabComm suitable as a storage format.
@@ -52,6 +52,7 @@ Two-way comminication adds complexity, in particular for hand-shaking
 during establishment of connections, and the LabComm library provides
 support for (for instance) avoiding deadlocks during such hand-shaking.
 
+\pagebreak
 \section{Communication model}
 
 LabComm provides self-describing communication channels, by always transmitting
@@ -70,9 +71,9 @@ During operation, LabComm will ensure (i.e., monitor) that a communication
 channel is fully configured, meaning that both ends agree on what messages that
 may be passed over that channel.  If an unregistered sample type is sent or
 received, the LabComm encoder or decoder will detect it and take action.
-
 In more dynamic applications, it is possible to reconfigure a channel in order to add,
-remove, or change the set of registerd sample types.
+remove, or change the set of registered sample types. This is discussed
+in Section~\ref{sec:reconfig}.
 
 The roles in setting up, and maintaining, the configuration of a channel are as follows:
 
@@ -97,7 +98,21 @@ The roles in setting up, and maintaining, the configuration of a channel are as
  \item if an unhandled signature is received, pauses the channel and informs the application
 \end{itemize}
 
+The fundamental communication model applies to all LabComm channels and
+deals with the individual unidirectional channels. In addition to that,
+the labcomm libraries support the implementation of higher-level
+handshaking and establishment of bidirectional channels both through
+means of interacting with the underlying transport layer (e.g., for
+marking packets containing signatures as \emph{important}, for
+transports that handle resending of dropped packets selectively), or
+requesting retransmission of signatures.
+
+In order to be both lean and generic, LabComm does not provide a
+complete protocol for establishing and negotiating bidirectional
+channels, but does provide support for building such protocols on top
+of LabComm.
 \subsection{Reconfiguration}
+\label{sec:reconfig}
 
 The fundamental communication model can be generalized to the life-cycle
 of a concrete communication channel, including the transport layer,
@@ -113,6 +128,21 @@ back from phase 3 to phase 2. That allows dynamic behaviour, as a sample
 type can be added or redefined at run-time. It also facilitates error
 handling in two-way channels.
 
+One example of this, more dynamic, view of a labcomm channel is that the
+action taken when an unregistered sample is sent or received is to
+revert back to the configuration phase and redo the handshaking to
+ensure that both sides agree on the set of sample types (i.e.,
+signatures) that are currently configured for the channel.
+
+From the system perspective, the LabComm protocol is involved in
+phases 2 and 3. The establishement of the \emph{transport-layer}
+channels is left to external application code. In the Labcomm library,
+that application code is connected to the LabComm routines through
+the \emph{reader} and \emph{writer} interfaces,
+with default implementations for sockets or file descriptors (i.e.,
+files and streams).
+
+
 \section{The Labcomm language}
 
 The LabComm language is used to describe data types, and from such data
@@ -122,7 +152,7 @@ some exceptions. We will now introduce the language through a set of
 examples.
 
 These examples do not cover the entire language
-specification (see appendix~\ref{language_grammar} for the complete
+specification (see appendix~\ref{sec:LanguageGrammar} for the complete
 grammar), but serve as a gentle introduction to the LabComm
 language covering most common use-cases.
 
@@ -152,7 +182,7 @@ language covering most common use-cases.
 
 \begin{enumerate}
 \item In contrast to C, LabComm supports both fixed and variable (denoted
-by \verb+_+) sized arrays.
+by~\verb+_+) sized arrays.
 
 \item In contrast to Java, LabComm supports multidimensional arrays and not
 only arrays of arrays.
@@ -183,7 +213,8 @@ only arrays of arrays.
 
 The LabComm system consists of a compiler for generating code from the data
 descriptions, and libraries providing LabComm communication facilities in,
-currently, C, Java, Python, and C\#.
+currently, C, Java, Python, C\#, and RAPID\footnote{excluding variable
+size samples, as RAPID has limited support for dynamic memory allocation}.
 
 
 \subsection{The LabComm compiler}
@@ -192,7 +223,7 @@ The LabComm compiler generates code for the declared samples, including marshall
 demarshalling code, in the supported target languages.
 
 The compiler itself is implemented in Java using the JastAdd~\cite{jastadd} compiler compiler.
-\pagebreak
+
 \subsection{The LabComm library}
 
 The LabComm libraries contain functionality for the end-to-end transmission
@@ -308,8 +339,12 @@ Java primitive types. However, it is unlikely that the entire range is actually
 way of supporting the common cases is to include run-time checks for overflow in the Java encoders
 and decoders.
 
+\bibliography{refs}{}
+\bibliographystyle{plain}
+
 \appendix
 \newpage
+
 \section{The LabComm language}
 \label{sec:LanguageGrammar}