man/status.Rd
3f24535c
 \name{status}
 
 \alias{status}
 \alias{status-methods}
 \alias{status,Streamer-method}
 
5978aaa4
 \title{Function to report current status of a stream}
3f24535c
 
 \description{
 
   \code{status} invoked on a stream yields the current status of the
   stream, as reported by the \code{status} methods of each component.
 
 }
 
 \usage{
 status(x, ...)
4464ce81
 
3f24535c
 \S4method{status}{Streamer}(x, ...)
 }
 
 \arguments{
   \item{x}{A \code{Stream}, \code{Producer}, or \code{Consumer} object.}
   \item{\dots}{Additional arguments, currently unused.}
 }
 
 \value{
 
   A component-specific summary the current status
 
 }
 
 \author{Martin Morgan \url{mtmorgan@fhcrc.org}}
 
 \seealso{
 
4464ce81
   \code{\link{Stream}}, \code{\linkS4class{Producer}},
3f24535c
   \code{\linkS4class{Consumer}}.
 
 }
 
 \examples{
4464ce81
 ## see example(Stream)
3f24535c
 }
 
 \keyword{ manip }