File: start.HttpDaemon.Rd

package info (click to toggle)
r-cran-r.rsp 0.46.0%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,472 kB
  • sloc: javascript: 612; tcl: 304; sh: 18; makefile: 16
file content (58 lines) | stat: -rw-r--r-- 1,699 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Do not modify this file since it was automatically generated from:
% 
%  HttpDaemon.R
% 
% by the Rdoc compiler part of the R.oo package.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\name{HttpDaemon$start}
\alias{HttpDaemon$start}
\alias{start.HttpDaemon}
\alias{HttpDaemon.start}
\alias{start,HttpDaemon-method}

\title{Starts the HTTP daemon}

\description{
 Starts the HTTP daemon.  Currently, only one HTTP daemon can run at each time,
 regardless of port used.
}

\usage{
## Static method (use this):
## HttpDaemon$start(rootPaths=NULL, port=8080, default="^index[.](html|.*)$", ...)

## Don't use the below:
\method{start}{HttpDaemon}(x, rootPaths=NULL, port=8080, default="^index[.](html|.*)$", ...)
}

\arguments{
  \item{rootPaths}{The path(s) to act as the root of the web server file
      system.  Files in parent directories of the root, will not be
      accessible.  If \code{\link[base]{NULL}}, the preset paths will be used,
      cf. \code{\link[R.rsp:setRootPaths.HttpDaemon]{*setRootPaths}()}.}
  \item{port}{The socket port the server listens to.}
  \item{default}{The default filename pattern to be retrieved if
      not specified.}
  \item{...}{Not used.}
}

\value{
 Returns nothing.
}

\author{Henrik Bengtsson}

\seealso{
  \code{\link[R.rsp:setRootPaths.HttpDaemon]{*setRootPaths}()}.
  \code{\link[R.rsp:isStarted.HttpDaemon]{*isStarted}()}.
  \code{\link[R.rsp:terminate.HttpDaemon]{*terminate}()}.
  \code{\link[R.rsp:restart.HttpDaemon]{*restart}()}.
  For more information see \code{\link{HttpDaemon}}.
}


\keyword{internal}
\keyword{methods}
\keyword{IO}