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

« back to all changes in this revision

Viewing changes to man/gInputStreamReadAsync.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{gInputStreamReadAsync}
 
2
\name{gInputStreamReadAsync}
 
3
\title{gInputStreamReadAsync}
 
4
\description{Request an asynchronous read of \code{count} bytes from the stream into the buffer
 
5
starting at \code{buffer}. When the operation is finished \code{callback} will be called. 
 
6
You can then call \code{\link{gInputStreamReadFinish}} to get the result of the 
 
7
operation.}
 
8
\usage{gInputStreamReadAsync(object, count, io.priority = 0, cancellable = NULL, callback, user.data = NULL)}
 
9
\arguments{
 
10
\item{\verb{object}}{A \code{\link{GInputStream}}.}
 
11
\item{\verb{count}}{the number of bytes that will be read from the stream}
 
12
\item{\verb{io.priority}}{the I/O priority 
 
13
of the request. }
 
14
\item{\verb{cancellable}}{optional \code{\link{GCancellable}} object, \code{NULL} to ignore.}
 
15
\item{\verb{callback}}{callback to call when the request is satisfied}
 
16
\item{\verb{user.data}}{the data to pass to callback function}
 
17
}
 
18
\details{During an async request no other sync and async calls are allowed on \code{stream}, and will
 
19
result in \code{G_IO_ERROR_PENDING} errors. 
 
20
  
 
21
A value of \code{count} larger than \code{G_MAXSSIZE} will cause a \code{G_IO_ERROR_INVALID_ARGUMENT} error.
 
22
  
 
23
On success, the number of bytes read into the buffer will be passed to the
 
24
callback. It is not an error if this is not the same as the requested size, as it
 
25
can happen e.g. near the end of a file, but generally we try to read
 
26
as many bytes as requested. Zero is returned on end of file
 
27
(or if \code{count} is zero),  but never otherwise.
 
28
  
 
29
Any outstanding i/o request with higher priority (lower numerical value) will
 
30
be executed before an outstanding request with lower priority. Default
 
31
priority is \code{G_PRIORITY_DEFAULT}.
 
32
  
 
33
The asyncronous methods have a default fallback that uses threads to implement
 
34
asynchronicity, so they are optional for inheriting classes. However, if you
 
35
override one you must override all.}
 
36
\value{
 
37
A list containing the following elements:
 
38
\item{\verb{buffer}}{a buffer to read data into (which should be at least count bytes long).}
 
39
}
 
40
\author{Derived by RGtkGen from GTK+ documentation}
 
41
\keyword{internal}