com.goldencode.p2j.library

Class NativeBuffer

java.lang.Object

com.goldencode.p2j.library.BaseNativeType

com.goldencode.p2j.library.NativeBuffer

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

public class NativeBuffer
extends BaseNativeType

A descriptor for memptr as an argument or return value to a native function.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected memptr	value The stored value.

Fields inherited from class com.goldencode.p2j.library.BaseNativeType

copyIn, copyOut, passByPointer, ptr, ref, type

Constructor Summary

Constructors

Constructor and Description
NativeBuffer() Default constructor.

Method Summary

Modifier and Type	Method and Description
memptr	getValue() Access the data element.
void	readExternal(java.io.ObjectInput in) Replacement for the default object reading method.
long	render(long addr) Render the data's address into native memory if an explicit address is provided and return the data's address to the caller.
void	restore(long addr) Copy back (if necessary) data from the native memory, if given.
void	setValue(memptr value) Assign the data element.
int	size() Report the size (in bytes) of the native memory needed to store this instance.
void	writeExternal(java.io.ObjectOutput out) Replacement for the default object writing method.

Methods inherited from class com.goldencode.p2j.library.BaseNativeType

isCopyIn, isCopyOut, isPassByPointer, render, restore, setCopyIn, setCopyOut, setPassByPointer, setType, type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

value

protected memptr value

The stored value.

Constructor Detail

NativeBuffer

public NativeBuffer()

Default constructor.

Method Detail

getValue

public memptr getValue()

Access the data element.

Returns:

The buffer.

setValue

public void setValue(memptr value)

Assign the data element.

Parameters:

value - The buffer.

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Replacement for the default object reading method. The latest state is read from the input source. The parent's state is read first.

Specified by:

readExternal in interface java.io.Externalizable

Overrides:

readExternal in class BaseNativeType

Parameters:

in - The input source from which fields will be restored.

Throws:

java.io.IOException - In case of I/O errors.

java.lang.ClassNotFoundException - If payload can't be instantiated.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Replacement for the default object writing method. The latest state is written to the output destination. The parent's state is written first.

Specified by:

writeExternal in interface java.io.Externalizable

Overrides:

writeExternal in class BaseNativeType

Parameters:

out - The output destination to which fields will be saved.

Throws:

java.io.IOException - In case of I/O errors.

size

public int size()

Report the size (in bytes) of the native memory needed to store this instance.

This should never be called on the server, only on the client side.

Specified by:

size in class BaseNativeType

Returns:

This is always the size of a pointer on the client platform.

render

public long render(long addr)

Render the data's address into native memory if an explicit address is provided and return the data's address to the caller.

This should never be called on the server, only on the client side.

Specified by:

render in class BaseNativeType

Parameters:

addr - The memory address to which the data should be rendered, if the caller is supplying a buffer or 0 if the target address should be returned directly (without further allocation or writing the address to any buffer).

Returns:

The memory address of the data value or 0 if there is no data to output.

restore

public void restore(long addr)

Copy back (if necessary) data from the native memory, if given.

This should never be called on the server, only on the client side.

Specified by:

restore in class BaseNativeType

Parameters:

addr - The memory address from which the data should be restored, if the caller is supplying a buffer or 0 if there is no data to copy back.