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

« back to all changes in this revision

Viewing changes to man/gSocketNew.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{gSocketNew}
 
2
\name{gSocketNew}
 
3
\title{gSocketNew}
 
4
\description{Creates a new \code{\link{GSocket}} with the defined family, type and protocol.
 
5
If \code{protocol} is 0 (\code{G_SOCKET_PROTOCOL_DEFAULT}) the default protocol type
 
6
for the family and type is used.}
 
7
\usage{gSocketNew(family, type, protocol, .errwarn = TRUE)}
 
8
\arguments{
 
9
\item{\verb{family}}{the socket family to use, e.g. \code{G_SOCKET_FAMILY_IPV4}.}
 
10
\item{\verb{type}}{the socket type to use.}
 
11
\item{\verb{protocol}}{the id of the protocol to use, or 0 for default.}
 
12
\item{.errwarn}{Whether to issue a warning on error or fail silently}
 
13
}
 
14
\details{The \code{protocol} is a family and type specific int that specifies what
 
15
kind of protocol to use. \code{\link{GSocketProtocol}} lists several common ones.
 
16
Many families only support one protocol, and use 0 for this, others
 
17
support several and using 0 means to use the default protocol for
 
18
the family and type.
 
19
  
 
20
The protocol id is passed directly to the operating
 
21
system, so you can use protocols not listed in \code{\link{GSocketProtocol}} if you
 
22
know the protocol number used for it.
 
23
  Since 2.22}
 
24
\value{
 
25
A list containing the following elements:
 
26
\item{retval}{[\code{\link{GSocket}}]  a \code{\link{GSocket}} or \code{NULL} on error.}
 
27
\item{\verb{error}}{\code{\link{GError}} for error reporting, or \code{NULL} to ignore.}
 
28
}
 
29
\author{Derived by RGtkGen from GTK+ documentation}
 
30
\keyword{internal}