- Parcel File Descriptor Class
- Definition
- Remarks
- Constructors
- Properties
- Methods
- Explicit Interface Implementations
- Extension Methods
- Parcel File Descriptor. Open Method
- Definition
- Overloads
- Open(File, ParcelFileMode)
- Parameters
- Returns
- Exceptions
- Remarks
- See also
- Applies to
- Open(File, ParcelFileMode, Handler, ParcelFileDescriptor+IOnCloseListener)
- Parameters
- Returns
- Exceptions
- Remarks
- ParcelFileDescriptor
- Class Overview
- Summary
- Constants
- public static final int MODE_APPEND
- public static final int MODE_CREATE
- public static final int MODE_READ_ONLY
- public static final int MODE_READ_WRITE
- public static final int MODE_TRUNCATE
- public static final int MODE_WORLD_READABLE
- public static final int MODE_WORLD_WRITEABLE
- public static final int MODE_WRITE_ONLY
- Fields
- public static final Creator CREATOR
- Public Constructors
- public ParcelFileDescriptor (ParcelFileDescriptor descriptor)
- Public Methods
- public static ParcelFileDescriptor adoptFd (int fd)
- public void close ()
- public static ParcelFileDescriptor[] createPipe ()
- public int describeContents ()
- public int detachFd ()
- public ParcelFileDescriptor dup ()
- public static ParcelFileDescriptor dup (FileDescriptor orig)
- public static ParcelFileDescriptor fromDatagramSocket (DatagramSocket datagramSocket)
- public static ParcelFileDescriptor fromFd (int fd)
- public static ParcelFileDescriptor fromSocket (Socket socket)
- public int getFd ()
- public FileDescriptor getFileDescriptor ()
- public long getStatSize ()
- public static ParcelFileDescriptor open (File file, int mode)
- public String toString ()
- public void writeToParcel (Parcel out, int flags)
- Protected Methods
- protected void finalize ()
Parcel File Descriptor Class
Definition
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
The FileDescriptor returned by Parcel#readFileDescriptor , allowing you to close it when done with it.
Remarks
Portions of this page are modifications based on work created andВ shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.
Constructors
A constructor used when creating managed representations of JNI objects; called by the runtime.
Create a new ParcelFileDescriptor wrapped around another descriptor.
Properties
Returns the runtime class of this Object .
(Inherited from Object)
Return the native fd int for this ParcelFileDescriptor.
Retrieve the actual FileDescriptor associated with this object.
The handle to the underlying Android instance.
(Inherited from Object)
Return the total size of the file representing this fd, as determined by stat() .
This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.
This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.
Methods
Take ownership of a raw native fd in to a new ParcelFileDescriptor.
Indicates if this ParcelFileDescriptor can communicate and detect remote errors/crashes.
Detect and throw if the other end of a pipe or socket pair encountered an error or crashed.
Creates and returns a copy of this object.
(Inherited from Object)
Close the ParcelFileDescriptor.
Close the ParcelFileDescriptor, informing any peer that an error occurred while processing.
Create two ParcelFileDescriptors structured as a data pipe.
Create two ParcelFileDescriptors structured as a data pipe.
Create two ParcelFileDescriptors structured as a pair of sockets connected to each other.
Create two ParcelFileDescriptors structured as a pair of sockets connected to each other.
Describe the kinds of special objects contained in this Parcelable’s marshalled representation.
Return the native fd int for this ParcelFileDescriptor and detach it from the object here.
Create a new ParcelFileDescriptor that is a dup of the existing FileDescriptor.
Create a new ParcelFileDescriptor that is a dup of the existing FileDescriptor.
Indicates whether some other object is «equal to» this one.
(Inherited from Object)
Create a new ParcelFileDescriptor from the specified DatagramSocket.
Create a new ParcelFileDescriptor from a raw native fd.
Create a new ParcelFileDescriptor from the specified Socket.
Returns a hash code value for the object.
(Inherited from Object)
Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
(Inherited from Object)
Wakes up a single thread that is waiting on this object’s monitor.
(Inherited from Object)
Wakes up all threads that are waiting on this object’s monitor.
(Inherited from Object)
Create a new ParcelFileDescriptor accessing a given file.
Create a new ParcelFileDescriptor accessing a given file.
Converts a string representing a file mode, such as «rw», into a bitmask suitable for use with #open .
Sets the Handle property.
(Inherited from Object)
Returns a string representation of the object.
(Inherited from Object)
Causes the current thread to wait until another thread invokes the java.lang.Object#notify() method or the java.lang.Object#notifyAll() method for this object.
(Inherited from Object)
Causes the current thread to wait until another thread invokes the java.lang.Object#notify() method or the java.lang.Object#notifyAll() method for this object.
(Inherited from Object)
Causes the current thread to wait until another thread invokes the java.lang.Object#notify() method or the java.lang.Object#notifyAll() method for this object.
(Inherited from Object)
Create a new ParcelFileDescriptor wrapping an already-opened file.
[TODO: @inheritDoc] If Parcelable#PARCELABLE_WRITE_RETURN_VALUE is set in flags, the file descriptor will be closed after a copy is written to the Parcel.
Explicit Interface Implementations
IJavaPeerable.Disposed() | (Inherited from Object) |
IJavaPeerable.DisposeUnlessReferenced() | (Inherited from Object) |
IJavaPeerable.Finalized() | (Inherited from Object) |
IJavaPeerable.JniManagedPeerState | (Inherited from Object) |
IJavaPeerable.SetJniIdentityHashCode(Int32) | (Inherited from Object) |
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) | (Inherited from Object) |
IJavaPeerable.SetPeerReference(JniObjectReference) | (Inherited from Object) |
Extension Methods
Performs an Android runtime-checked type conversion.
Источник
Parcel File Descriptor. Open Method
Definition
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
Create a new ParcelFileDescriptor accessing a given file.
Create a new ParcelFileDescriptor accessing a given file.
Open(File, ParcelFileMode)
Create a new ParcelFileDescriptor accessing a given file.
Parameters
The file to be opened.
The desired access mode, must be one of #MODE_READ_ONLY , #MODE_WRITE_ONLY , or #MODE_READ_WRITE ; may also be any combination of #MODE_CREATE , #MODE_TRUNCATE , #MODE_WORLD_READABLE , and #MODE_WORLD_WRITEABLE .
Returns
a new ParcelFileDescriptor pointing to the given file.
Exceptions
if the given file does not exist or can not be opened with the requested mode.
Remarks
Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.
See also
Applies to
Open(File, ParcelFileMode, Handler, ParcelFileDescriptor+IOnCloseListener)
Create a new ParcelFileDescriptor accessing a given file.
Parameters
The file to be opened.
The desired access mode, must be one of #MODE_READ_ONLY , #MODE_WRITE_ONLY , or #MODE_READ_WRITE ; may also be any combination of #MODE_CREATE , #MODE_TRUNCATE , #MODE_WORLD_READABLE , and #MODE_WORLD_WRITEABLE .
to call listener from; must not be null.
to be invoked when the returned descriptor has been closed; must not be null.
Returns
a new ParcelFileDescriptor pointing to the given file.
Exceptions
if the given file does not exist or can not be opened with the requested mode.
Remarks
Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.
Источник
ParcelFileDescriptor
Class Overview
The FileDescriptor returned by readFileDescriptor() , allowing you to close it when done with it.
Summary
Nested Classes | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ParcelFileDescriptor.AutoCloseInputStream | An InputStream you can create on a ParcelFileDescriptor, which will take care of calling ParcelFileDescriptor.close() for you when the stream is closed. | |||||||||||||||||||
ParcelFileDescriptor.AutoCloseOutputStream | An OutputStream you can create on a ParcelFileDescriptor, which will take care of calling ParcelFileDescriptor.close() for you when the stream is closed. |
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
int | MODE_APPEND | For use with open(File, int) : append to end of file while writing. | |||||||||
int | MODE_CREATE | For use with open(File, int) : create the file if it doesn’t already exist. | |||||||||
int | MODE_READ_ONLY | For use with open(File, int) : open the file with read-only access. | |||||||||
int | MODE_READ_WRITE | For use with open(File, int) : open the file with read and write access. | |||||||||
int | MODE_TRUNCATE | For use with open(File, int) : erase contents of file when opening. | |||||||||
int | MODE_WORLD_READABLE | For use with open(File, int) : if MODE_CREATE has been supplied and this file doesn’t already exist, then create the file with permissions such that any application can read it. | |||||||||
int | MODE_WORLD_WRITEABLE | For use with open(File, int) : if MODE_CREATE has been supplied and this file doesn’t already exist, then create the file with permissions such that any application can write it. | |||||||||
int | MODE_WRITE_ONLY | For use with open(File, int) : open the file with write-only access. |
[Expand]
|
---|
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
CREATOR |
Public Constructors |
---|
Public Methods | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Constantspublic static final int MODE_APPENDFor use with open(File, int) : append to end of file while writing. public static final int MODE_CREATEFor use with open(File, int) : create the file if it doesn’t already exist. public static final int MODE_READ_ONLYFor use with open(File, int) : open the file with read-only access. public static final int MODE_READ_WRITEFor use with open(File, int) : open the file with read and write access. public static final int MODE_TRUNCATEFor use with open(File, int) : erase contents of file when opening. public static final int MODE_WORLD_READABLEFor use with open(File, int) : if MODE_CREATE has been supplied and this file doesn’t already exist, then create the file with permissions such that any application can read it. public static final int MODE_WORLD_WRITEABLEFor use with open(File, int) : if MODE_CREATE has been supplied and this file doesn’t already exist, then create the file with permissions such that any application can write it. public static final int MODE_WRITE_ONLYFor use with open(File, int) : open the file with write-only access. Fieldspublic static final Creator CREATORPublic Constructorspublic ParcelFileDescriptor (ParcelFileDescriptor descriptor)Public Methodspublic static ParcelFileDescriptor adoptFd (int fd)Take ownership of a raw native fd in to a new ParcelFileDescriptor. The returned ParcelFileDescriptor now owns the given fd, and will be responsible for closing it. You must not close the fd yourself. Parameters
Returns
public void close ()Close the ParcelFileDescriptor. This implementation closes the underlying OS resources allocated to represent this stream. Throws
public static ParcelFileDescriptor[] createPipe ()Create two ParcelFileDescriptors structured as a data pipe. The first ParcelFileDescriptor in the returned array is the read side; the second is the write side. Throwspublic int describeContents ()Describe the kinds of special objects contained in this Parcelable’s marshalled representation. Returns
public int detachFd ()Return the native fd int for this ParcelFileDescriptor and detach it from the object here. You are now responsible for closing the fd in native code. public ParcelFileDescriptor dup ()Create a new ParcelFileDescriptor that is a dup of the existing FileDescriptor. This obeys standard POSIX semantics, where the new file descriptor shared state such as file position with the original file descriptor. Throwspublic static ParcelFileDescriptor dup (FileDescriptor orig)Create a new ParcelFileDescriptor that is a dup of an existing FileDescriptor. This obeys standard POSIX semantics, where the new file descriptor shared state such as file position with the original file descriptor. Throwspublic static ParcelFileDescriptor fromDatagramSocket (DatagramSocket datagramSocket)Create a new ParcelFileDescriptor from the specified DatagramSocket. Parameters
Returns
public static ParcelFileDescriptor fromFd (int fd)Create a new ParcelFileDescriptor from a raw native fd. The new ParcelFileDescriptor holds a dup of the original fd passed in here, so you must still close that fd as well as the new ParcelFileDescriptor. Parameters
Returns
Throwspublic static ParcelFileDescriptor fromSocket (Socket socket)Create a new ParcelFileDescriptor from the specified Socket. The new ParcelFileDescriptor holds a dup of the original FileDescriptor in the Socket, so you must still close the Socket as well as the new ParcelFileDescriptor. Parameters
Returns
public int getFd ()Return the native fd int for this ParcelFileDescriptor. The ParcelFileDescriptor still owns the fd, and it still must be closed through this API. public FileDescriptor getFileDescriptor ()Retrieve the actual FileDescriptor associated with this object. Returns
public long getStatSize ()Return the total size of the file representing this fd, as determined by stat(). Returns -1 if the fd is not a file. public static ParcelFileDescriptor open (File file, int mode)Create a new ParcelFileDescriptor accessing a given file. Parameters
Returns
Throws
public String toString ()Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object’s type and data. The default implementation is equivalent to the following expression: See Writing a useful toString method if you intend implementing your own toString method. Returns
public void writeToParcel (Parcel out, int flags)Flatten this object in to a Parcel. If PARCELABLE_WRITE_RETURN_VALUE is set in flags, the file descriptor will be closed after a copy is written to the Parcel. Parameters
Protected Methodsprotected void finalize ()Invoked when the garbage collector has detected that this instance is no longer reachable. The default implementation does nothing, but this method can be overridden to free resources. Note that objects that override finalize are significantly more expensive than objects that don’t. Finalizers may be run a long time after the object is no longer reachable, depending on memory pressure, so it’s a bad idea to rely on them for cleanup. Note also that finalizers are run on a single VM-wide finalizer thread, so doing blocking work in a finalizer is a bad idea. A finalizer is usually only necessary for a class that has a native peer and needs to call a native method to destroy that peer. Even then, it’s better to provide an explicit close method (and implement Closeable ), and insist that callers manually dispose of instances. This works well for something like files, but less well for something like a BigInteger where typical calling code would have to deal with lots of temporaries. Unfortunately, code that creates lots of temporaries is the worst kind of code from the point of view of the single finalizer thread. If you must use finalizers, consider at least providing your own ReferenceQueue and having your own thread process that queue. Unlike constructors, finalizers are not automatically chained. You are responsible for calling super.finalize() yourself. Uncaught exceptions thrown by finalizers are ignored and do not terminate the finalizer thread. See Effective Java Item 7, «Avoid finalizers» for more. Источник |