nxm.ice.lib

Class RamDiskResource

java.lang.Object

nxm.sys.lib.IOResource

nxm.ice.lib.RamDiskResource

public class RamDiskResource
extends nxm.sys.lib.IOResource

Resource for interacting with an ICE RamDisk using native code.

Author:

Jeff Schoen

Field Summary

Fields

Modifier and Type	Field and Description
DevIce.DmaMap	map
MDevIce	pic

Fields inherited from class nxm.sys.lib.IOResource

DIR_INOUT, DIR_INPUT, DIR_INPUT_TRUNC, DIR_OUTPUT, DIR_OUTPUT_TRUNC, FILE, FTP, HTTP, isOpen, JAR, MFTP, NFILE, PIPE, RAM, RAMD, SOCK, typeList, UDP, UNKNOWN, URL, USER

Constructor Summary

Constructors

Constructor and Description
RamDiskResource()

Method Summary

Modifier and Type	Method and Description
long	avail() get currently available length of resource
int	checkAllocation(int bytes)
boolean	close() close the resource
boolean	delete() delete the resource
boolean	exists() Test for the existence of the resource.
long	getLength() get length of resource
long	getPhysicalAddress()
nxm.sys.lib.Table	getStatFS() Gets statistics of file system that this resource is located on.
boolean	isFile() Indicates if this resource is a traditional file.
boolean	open() open the resource
int	read(byte[] buf, int boff, int bytes) read data from resource
int	read(long lbuf, int boff, int bytes) read data from resource
boolean	seek(long offset) seek to the specified offset in file
void	setURL(java.lang.String str) Set the URL that this resource points to.
java.lang.String	toString() Return a printable string containing information about this object.
int	write(byte[] buf, int boff, int bytes) write data to resource
int	write(long lbuf, int boff, int bytes) write data to resource

Methods inherited from class nxm.sys.lib.IOResource

dirToString, getContext, getDir, getEntry, getEntryList, getInputStream, getInstance, getOutputStream, getQualifier, getStateQualifier, getType, getType, getTypeString, getTypeString, getURL, getUrlStream, init, isContainer, isJarFile, isPipe, isReady, isStream, isStreaming, lastModified, lastModifiedTime, open, read, seek, setContext, setDir, setLength, setQualifiers, setType, write

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

pic

public MDevIce pic

map

public DevIce.DmaMap map

Constructor Detail

RamDiskResource

public RamDiskResource()

Method Detail

exists

public boolean exists()

Test for the existence of the resource.

Overrides:

exists in class nxm.sys.lib.IOResource

Returns:

true if it exists, false otherwise.

isFile

public boolean isFile()

Description copied from class: nxm.sys.lib.IOResource

Indicates if this resource is a traditional file. This method was added in NeXtMidas 2.1.0 to go along with IOResource.isPipe() (previously (getType() == FILE) was used).

Overrides:

isFile in class nxm.sys.lib.IOResource

Returns:

true if it is, false otherwise.

setURL

public void setURL(java.lang.String str)

Set the URL that this resource points to.

Overrides:

setURL in class nxm.sys.lib.IOResource

Parameters:

str - The fully qualified URL of the resource.

open

public boolean open()

open the resource

Overrides:

open in class nxm.sys.lib.IOResource

Returns:

true if it is successful, false otherwise.

close

public boolean close()

close the resource

Overrides:

close in class nxm.sys.lib.IOResource

Returns:

true if it is successful, false otherwise.

delete

public boolean delete()

delete the resource

Overrides:

delete in class nxm.sys.lib.IOResource

Returns:

true if it is successful, false otherwise.

getLength

public long getLength()

get length of resource

Overrides:

getLength in class nxm.sys.lib.IOResource

Returns:

The length of the resource in bytes.

seek

public boolean seek(long offset)

seek to the specified offset in file

Overrides:

seek in class nxm.sys.lib.IOResource

Parameters:

offset - Current seek offset in bytes (0..N-1).

Returns:

true on success, false on failure.

avail

public long avail()

get currently available length of resource

Overrides:

avail in class nxm.sys.lib.IOResource

Returns:

The number of bytes currently available for reading.

read

public int read(byte[] buf,
                int boff,
                int bytes)

read data from resource

Overrides:

read in class nxm.sys.lib.IOResource

Parameters:

buf - The byte buffer to read into.

boff - The byte offset into the byte array to start writing at.

bytes - The number of bytes to try to read.

Returns:

The number of bytes read (may be less than bytes when at end-of-file or no more data is available), -1 at the end of the file (EOF), or -3 (CoreIO.ERROR) on error.

write

public int write(byte[] buf,
                 int boff,
                 int bytes)

write data to resource

Overrides:

write in class nxm.sys.lib.IOResource

Parameters:

buf - The byte buffer to write from.

boff - The byte offset into the byte array to start writing from.

bytes - The number of bytes to try to write.

Returns:

The number of bytes written or -1 if none could be written (possibly a read-only source).

read

public int read(long lbuf,
                int boff,
                int bytes)

read data from resource

Overrides:

read in class nxm.sys.lib.IOResource

Parameters:

lbuf - Native pointer to buffer.

boff - The offset into buf to start at.

bytes - The number of bytes to try reading.

Returns:

Number of bytes actually read in (may be less than bytes when at end-of-file or no more data is available) or a value <0 if the end of the file has been reached or on error: -1 at the end of the file (EOF), or -3 (CoreIO.ERROR) on error.

See Also:

IOResource.read(byte[], int, int)

write

public int write(long lbuf,
                 int boff,
                 int bytes)

write data to resource

Overrides:

write in class nxm.sys.lib.IOResource

Parameters:

lbuf - Native pointer to buffer.

boff - The offset into buf to start at.

bytes - The number of bytes to write out.

Returns:

Number of bytes actually written. (In practice this is almost always equal to bytes.)

toString

public java.lang.String toString()

Return a printable string containing information about this object.

Overrides:

toString in class java.lang.Object

checkAllocation

public int checkAllocation(int bytes)

getPhysicalAddress

public long getPhysicalAddress()

getStatFS

public nxm.sys.lib.Table getStatFS()

Description copied from class: nxm.sys.lib.IOResource

Gets statistics of file system that this resource is located on.

Overrides:

getStatFS in class nxm.sys.lib.IOResource

Returns:

Table of file system statistics of where this resource is located if available, otherwise null.