org.rococoa.cocoa.cfnetwork
Class CFHostClientContext

java.lang.Object
  com.sun.jna.Structure
      com.ochafik.lang.jnaerator.runtime.Structure
          org.rococoa.cocoa.cfnetwork.CFHostClientContext

Direct Known Subclasses:

CFHostClientContext.ByReference, CFHostClientContext.ByValue

public class CFHostClientContext
extends com.ochafik.lang.jnaerator.runtime.Structure

CFHostClientContext

Discussion:
Structure containing the user-defined data and callbacks for
CFHost objects.
This file was autogenerated by JNAerator,
a tool written by Olivier Chafik that uses a few opensource projects..
For help, please visit NativeLibs4Java, Rococoa, or JNA.

Nested Class Summary

static class	CFHostClientContext.ByReference
static class	CFHostClientContext.ByValue

Field Summary

CoreFoundationLibrary.CFAllocatorCopyDescriptionCallBack	copyDescription The callback used to create a descriptive string representation of the info pointer (or the data pointed to by the info pointer) for debugging purposes.
Pointer	info An arbitrary pointer to client-defined data, which can be associated with the host and is passed to the callbacks.
CoreFoundationLibrary.CFAllocatorReleaseCallBack	release The callback used to remove a retain previously added for the host on the info pointer.
CoreFoundationLibrary.CFAllocatorRetainCallBack	retain The callback used to add a retain for the host on the info pointer for the life of the host, and may be used for temporary references the host needs to take.
NativeLong	version The version number of the structure type being passed in as a parameter to the CFHost client function.

Fields inherited from class com.sun.jna.Structure

ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE

Constructor Summary

CFHostClientContext()

CFHostClientContext(NativeLong version, Pointer info, CoreFoundationLibrary.CFAllocatorRetainCallBack retain, CoreFoundationLibrary.CFAllocatorReleaseCallBack release, CoreFoundationLibrary.CFAllocatorCopyDescriptionCallBack copyDescription)

Method Summary

CFHostClientContext.ByReference	byReference()
CFHostClientContext.ByValue	byValue()
CFHostClientContext	clone()

Methods inherited from class com.ochafik.lang.jnaerator.runtime.Structure

setupClone

Methods inherited from class com.sun.jna.Structure

allocateMemory, allocateMemory, cacheTypeInfo, clear, ensureAllocated, equals, getAutoRead, getAutoWrite, getFieldOrder, getNativeAlignment, getPointer, getStructAlignment, hashCode, newInstance, read, readField, setAlignType, setAutoRead, setAutoSynch, setAutoWrite, setFieldOrder, setTypeMapper, size, sortFields, toArray, toArray, toString, useMemory, useMemory, write, writeField, writeField

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

version

public NativeLong version

The version number of the structure type being passed in as a
parameter to the CFHost client function. Valid version number is
currently 0.

info

public Pointer info

An arbitrary pointer to client-defined data, which can be
associated with the host and is passed to the callbacks.

retain

public CoreFoundationLibrary.CFAllocatorRetainCallBack retain

The callback used to add a retain for the host on the info pointer
for the life of the host, and may be used for temporary references
the host needs to take. This callback returns the actual info
pointer to store in the host, almost always just the pointer
passed as the parameter.

release

public CoreFoundationLibrary.CFAllocatorReleaseCallBack release

The callback used to remove a retain previously added for the host
on the info pointer.

copyDescription

public CoreFoundationLibrary.CFAllocatorCopyDescriptionCallBack copyDescription

The callback used to create a descriptive string representation of
the info pointer (or the data pointed to by the info pointer) for
debugging purposes. This is used by the CFCopyDescription()
function.

Constructor Detail

CFHostClientContext

public CFHostClientContext()

CFHostClientContext

public CFHostClientContext(NativeLong version,
                           Pointer info,
                           CoreFoundationLibrary.CFAllocatorRetainCallBack retain,
                           CoreFoundationLibrary.CFAllocatorReleaseCallBack release,
                           CoreFoundationLibrary.CFAllocatorCopyDescriptionCallBack copyDescription)

Parameters:

version - The version number of the structure type being passed in as a
parameter to the CFHost client function. Valid version number is
currently 0.

info - An arbitrary pointer to client-defined data, which can be
associated with the host and is passed to the callbacks.

retain - The callback used to add a retain for the host on the info pointer
for the life of the host, and may be used for temporary references
the host needs to take. This callback returns the actual info
pointer to store in the host, almost always just the pointer
passed as the parameter.

release - The callback used to remove a retain previously added for the host
on the info pointer.

copyDescription - The callback used to create a descriptive string representation of
the info pointer (or the data pointed to by the info pointer) for
debugging purposes. This is used by the CFCopyDescription()
function.

Method Detail

byReference

public CFHostClientContext.ByReference byReference()

byValue

public CFHostClientContext.ByValue byValue()

clone

public CFHostClientContext clone()

Overrides:

clone in class Object