~ubuntu-branches/ubuntu/trusty/rgtk2/trusty

« back to all changes in this revision

Viewing changes to man/gSocketListenerAddAddress.Rd

  • Committer: Bazaar Package Importer
  • Author(s): Dirk Eddelbuettel
  • Date: 2010-11-03 11:35:46 UTC
  • mfrom: (1.3.7 upstream)
  • Revision ID: james.westby@ubuntu.com-20101103113546-a7fi7jdxdebp0tw1
Tags: 2.20.1-1
* New upstream release

* debian/control: Set (Build-)Depends: to current R version
* debian/control: Set Standards-Version: to current version 

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
\alias{gSocketListenerAddAddress}
 
2
\name{gSocketListenerAddAddress}
 
3
\title{gSocketListenerAddAddress}
 
4
\description{Creates a socket of type \code{type} and protocol \code{protocol}, binds
 
5
it to \code{address} and adds it to the set of sockets we're accepting
 
6
sockets from.}
 
7
\usage{gSocketListenerAddAddress(object, address, type, protocol, source.object, .errwarn = TRUE)}
 
8
\arguments{
 
9
\item{\verb{object}}{a \code{\link{GSocketListener}}}
 
10
\item{\verb{address}}{a \code{\link{GSocketAddress}}}
 
11
\item{\verb{type}}{a \code{\link{GSocketType}}}
 
12
\item{\verb{protocol}}{a \code{\link{GSocketProtocol}}}
 
13
\item{\verb{source.object}}{Optional \code{\link{GObject}} identifying this source}
 
14
\item{.errwarn}{Whether to issue a warning on error or fail silently}
 
15
}
 
16
\details{Note that adding an IPv6 address, depending on the platform,
 
17
may or may not result in a listener that also accepts IPv4
 
18
connections.  For more determinstic behaviour, see
 
19
\code{\link{gSocketListenerAddInetPort}}.
 
20
  \code{source.object} will be passed out in the various calls
 
21
to accept to identify this particular source, which is
 
22
useful if you're listening on multiple addresses and do
 
23
different things depending on what address is connected to.
 
24
  
 
25
If successful and \code{effective.address} is non-\code{NULL} then it will
 
26
be set to the address that the binding actually occured at.  This
 
27
is helpful for determining the port number that was used for when
 
28
requesting a binding to port 0 (ie: "any port").  This address, if
 
29
requested, belongs to the caller and must be freed.
 
30
  Since 2.22}
 
31
\value{
 
32
A list containing the following elements:
 
33
\item{retval}{[logical] \code{TRUE} on success, \code{FALSE} on error.}
 
34
\item{\verb{effective.address}}{location to store the address that was bound to, or \code{NULL}.}
 
35
\item{\verb{error}}{\code{\link{GError}} for error reporting, or \code{NULL} to ignore.}
 
36
}
 
37
\author{Derived by RGtkGen from GTK+ documentation}
 
38
\keyword{internal}