Klasse Structure
- Bekannte direkte Unterklassen:
CallbackReference.AttachOptions,Carbon.EventHotKeyID,Carbon.EventTypeSpec,DBT.DEV_BROADCAST_DEVICEINTERFACE,DBT.DEV_BROADCAST_DEVNODE,DBT.DEV_BROADCAST_HANDLE,DBT.DEV_BROADCAST_HDR,DBT.DEV_BROADCAST_NET,DBT.DEV_BROADCAST_OEM,DBT.DEV_BROADCAST_PORT,DBT.DEV_BROADCAST_VOLUME,Ddeml.CONVCONTEXT,Ddeml.CONVINFO,Ddeml.DDEML_MSG_HOOK_DATA,Ddeml.HSZPAIR,Ddeml.MONCBSTRUCT,Ddeml.MONCONVSTRUCT,Ddeml.MONERRSTRUCT,Ddeml.MONHSZSTRUCT,Ddeml.MONLINKSTRUCT,Ddeml.MONMSGSTRUCT,DispatchListener,DispatchVTable,DsGetDC.DOMAIN_CONTROLLER_INFO,DsGetDC.DS_DOMAIN_TRUSTS,DsGetDC.PDOMAIN_CONTROLLER_INFO,Guid.GUID,IPHlpAPI.FIXED_INFO,IPHlpAPI.IP_ADDR_STRING,IPHlpAPI.IP_ADDRESS_STRING,IPHlpAPI.MIB_IF_ROW2,IPHlpAPI.MIB_IFROW,IPHlpAPI.MIB_TCP6ROW_OWNER_PID,IPHlpAPI.MIB_TCP6TABLE_OWNER_PID,IPHlpAPI.MIB_TCPROW_OWNER_PID,IPHlpAPI.MIB_TCPSTATS,IPHlpAPI.MIB_TCPTABLE_OWNER_PID,IPHlpAPI.MIB_UDP6ROW_OWNER_PID,IPHlpAPI.MIB_UDP6TABLE_OWNER_PID,IPHlpAPI.MIB_UDPROW_OWNER_PID,IPHlpAPI.MIB_UDPSTATS,IPHlpAPI.MIB_UDPTABLE_OWNER_PID,Kstat2.Kstat2NV,Kstat2.Kstat2NV.UNION.IntegersArr,Kstat2.Kstat2NV.UNION.StringsArr,LibC.Statvfs,LibC.Sysinfo,LibKstat.Kstat,LibKstat.KstatCtl,LibKstat.KstatIntr,LibKstat.KstatIO,LibKstat.KstatNamed,LibKstat.KstatNamed.UNION.STR,LibKstat.KstatTimer,LMAccess.GROUP_INFO_0,LMAccess.GROUP_INFO_1,LMAccess.GROUP_INFO_2,LMAccess.GROUP_INFO_3,LMAccess.GROUP_USERS_INFO_0,LMAccess.LOCALGROUP_INFO_0,LMAccess.LOCALGROUP_INFO_1,LMAccess.LOCALGROUP_USERS_INFO_0,LMAccess.USER_INFO_0,LMAccess.USER_INFO_1,LMAccess.USER_INFO_23,LMShare.SHARE_INFO_2,LMShare.SHARE_INFO_502,LowLevelMonitorConfigurationAPI.MC_TIMING_REPORT,MacFileUtils.FileManager.FSRef,Netapi32.SESSION_INFO_10,Ntifs.GenericReparseBuffer,Ntifs.MountPointReparseBuffer,Ntifs.REPARSE_DATA_BUFFER,Ntifs.SymbolicLinkReparseBuffer,NTSecApi.LSA_FOREST_TRUST_BINARY_DATA,NTSecApi.LSA_FOREST_TRUST_DOMAIN_INFO,NTSecApi.LSA_FOREST_TRUST_INFORMATION,NTSecApi.LSA_FOREST_TRUST_RECORD,NTSecApi.LSA_UNICODE_STRING,NTSecApi.PLSA_FOREST_TRUST_INFORMATION,NTSecApi.PLSA_FOREST_TRUST_RECORD,OaIdl.ARRAYDESC,OaIdl.CALLCONV,OaIdl.CURRENCY._CURRENCY,OaIdl.DATE,OaIdl.DECIMAL,OaIdl.DECIMAL._DECIMAL1._DECIMAL1_DECIMAL,OaIdl.DECIMAL._DECIMAL2._DECIMAL2_DECIMAL,OaIdl.DESCKIND,OaIdl.ELEMDESC,OaIdl.ElemDescArg,OaIdl.EXCEPINFO,OaIdl.FUNCDESC,OaIdl.FUNCKIND,OaIdl.IDLDESC,OaIdl.INVOKEKIND,OaIdl.LIBFLAGS,OaIdl.PARAMDESC,OaIdl.PARAMDESCEX,OaIdl.SAFEARRAY,OaIdl.SAFEARRAYBOUND,OaIdl.SAFEARRAYByReference,OaIdl.ScodeArg,OaIdl.SYSKIND,OaIdl.TLIBATTR,OaIdl.TYPEATTR,OaIdl.TYPEDESC,OaIdl.TYPEKIND,OaIdl.VARDESC,OaIdl.VARKIND,OleAuto.DISPPARAMS,Pdh.PDH_COUNTER_PATH_ELEMENTS,Pdh.PDH_RAW_COUNTER,Pdh.PDH_TIME_INFO,Perfstat.perfstat_cpu_t,Perfstat.perfstat_cpu_total_t,Perfstat.perfstat_disk_t,Perfstat.perfstat_id_t,Perfstat.perfstat_memory_total_t,Perfstat.perfstat_netinterface_t,Perfstat.perfstat_partition_config_t,Perfstat.perfstat_process_t,Perfstat.perfstat_protocol_t,Perfstat.perfstat_protocol_t.AnonymousStructICMP,Perfstat.perfstat_protocol_t.AnonymousStructICMPv6,Perfstat.perfstat_protocol_t.AnonymousStructIP,Perfstat.perfstat_protocol_t.AnonymousStructIPv6,Perfstat.perfstat_protocol_t.AnonymousStructNFS,Perfstat.perfstat_protocol_t.AnonymousStructNFSclient,Perfstat.perfstat_protocol_t.AnonymousStructNFSserver,Perfstat.perfstat_protocol_t.AnonymousStructNFSv2,Perfstat.perfstat_protocol_t.AnonymousStructNFSv2client,Perfstat.perfstat_protocol_t.AnonymousStructNFSv2server,Perfstat.perfstat_protocol_t.AnonymousStructNFSv3,Perfstat.perfstat_protocol_t.AnonymousStructNFSv3client,Perfstat.perfstat_protocol_t.AnonymousStructNFSv3server,Perfstat.perfstat_protocol_t.AnonymousStructNFSv4,Perfstat.perfstat_protocol_t.AnonymousStructNFSv4client,Perfstat.perfstat_protocol_t.AnonymousStructNFSv4server,Perfstat.perfstat_protocol_t.AnonymousStructRPC,Perfstat.perfstat_protocol_t.AnonymousStructRPCclient,Perfstat.perfstat_protocol_t.AnonymousStructRPCclientdgram,Perfstat.perfstat_protocol_t.AnonymousStructRPCclientstream,Perfstat.perfstat_protocol_t.AnonymousStructRPCserver,Perfstat.perfstat_protocol_t.AnonymousStructRPCserverdgram,Perfstat.perfstat_protocol_t.AnonymousStructRPCserverstream,Perfstat.perfstat_protocol_t.AnonymousStructTCP,Perfstat.perfstat_protocol_t.AnonymousStructUDP,Perfstat.perfstat_value_t,PhysicalMonitorEnumerationAPI.PHYSICAL_MONITOR,Psapi.MODULEINFO,Psapi.PERFORMANCE_INFORMATION,Psapi.PSAPI_WORKING_SET_EX_INFORMATION,Resource.Rlimit,SetupApi.SP_DEVICE_INTERFACE_DATA,SetupApi.SP_DEVINFO_DATA,ShellAPI.APPBARDATA,ShellAPI.SHELLEXECUTEINFO,ShellAPI.SHFILEOPSTRUCT,ShTypes.STRRET,Sspi.PSecHandle,Sspi.PSecPkgInfo,Sspi.SEC_WINNT_AUTH_IDENTITY,Sspi.SecBuffer,Sspi.SecBufferDesc,Sspi.SecHandle,Sspi.SecPkgContext_Flags,Sspi.SecPkgContext_KeyInfo,Sspi.SecPkgContext_Lifespan,Sspi.SecPkgContext_NegotiationInfo,Sspi.SecPkgContext_PackageInfo,Sspi.SecPkgContext_SessionKey,Sspi.SecPkgContext_Sizes,Sspi.SecPkgCredentials_Names,Sspi.SecPkgInfo,Sspi.SECURITY_INTEGER,Structure.FFIType,SystemB.Group,SystemB.HostCpuLoadInfo,SystemB.HostLoadInfo,SystemB.IFdata,SystemB.IFdata64,SystemB.IFmsgHdr,SystemB.IFmsgHdr2,SystemB.Passwd,SystemB.ProcBsdInfo,SystemB.ProcTaskAllInfo,SystemB.ProcTaskInfo,SystemB.RUsageInfoV2,SystemB.Statfs,SystemB.Timeval,SystemB.Timezone,SystemB.VMMeter,SystemB.VMStatistics,SystemB.VMStatistics64,SystemB.VnodeInfoPath,SystemB.VnodePathInfo,SystemB.XswUsage,Tlhelp32.MODULEENTRY32W,Tlhelp32.PROCESSENTRY32,Tlhelp32.THREADENTRY32,Union,UnknownListener,UnknownVTable,Variant.VARIANT._VARIANT,Variant.VARIANT._VARIANT.__VARIANT.BRECORD,Variant.VariantArg,VerRsrc.VS_FIXEDFILEINFO,Wdm.KEY_BASIC_INFORMATION,WinBase.COMMTIMEOUTS,WinBase.DCB,WinBase.FILE_ATTRIBUTE_TAG_INFO,WinBase.FILE_BASIC_INFO,WinBase.FILE_COMPRESSION_INFO,WinBase.FILE_DISPOSITION_INFO,WinBase.FILE_ID_INFO,WinBase.FILE_ID_INFO.FILE_ID_128,WinBase.FILE_STANDARD_INFO,WinBase.FILETIME,WinBase.FOREIGN_THREAD_START_ROUTINE,WinBase.MEMORYSTATUSEX,WinBase.OVERLAPPED,WinBase.PROCESS_INFORMATION,WinBase.SECURITY_ATTRIBUTES,WinBase.STARTUPINFO,WinBase.SYSTEM_INFO,WinBase.SYSTEM_INFO.PI,WinBase.SYSTEMTIME,WinBase.TIME_ZONE_INFORMATION,WinBase.WIN32_FIND_DATA,Wincon.CONSOLE_SCREEN_BUFFER_INFO,Wincon.COORD,Wincon.INPUT_RECORD,Wincon.KEY_EVENT_RECORD,Wincon.MOUSE_EVENT_RECORD,Wincon.SMALL_RECT,Wincon.WINDOW_BUFFER_SIZE_RECORD,WinCrypt.CERT_CHAIN_CONTEXT,WinCrypt.CERT_CHAIN_ELEMENT,WinCrypt.CERT_CHAIN_PARA,WinCrypt.CERT_CHAIN_POLICY_PARA,WinCrypt.CERT_CHAIN_POLICY_STATUS,WinCrypt.CERT_CONTEXT,WinCrypt.CERT_EXTENSION,WinCrypt.CERT_EXTENSIONS,WinCrypt.CERT_INFO,WinCrypt.CERT_PUBLIC_KEY_INFO,WinCrypt.CERT_REVOCATION_CRL_INFO,WinCrypt.CERT_REVOCATION_INFO,WinCrypt.CERT_SIMPLE_CHAIN,WinCrypt.CERT_STRONG_SIGN_PARA,WinCrypt.CERT_STRONG_SIGN_SERIALIZED_INFO,WinCrypt.CERT_TRUST_LIST_INFO,WinCrypt.CERT_TRUST_STATUS,WinCrypt.CERT_USAGE_MATCH,WinCrypt.CRL_CONTEXT,WinCrypt.CRL_ENTRY,WinCrypt.CRL_INFO,WinCrypt.CRYPT_ALGORITHM_IDENTIFIER,WinCrypt.CRYPT_ATTRIBUTE,WinCrypt.CRYPT_BIT_BLOB,WinCrypt.CRYPT_KEY_PROV_INFO,WinCrypt.CRYPT_KEY_PROV_PARAM,WinCrypt.CRYPT_SIGN_MESSAGE_PARA,WinCrypt.CRYPT_VERIFY_MESSAGE_PARA,WinCrypt.CRYPTPROTECT_PROMPTSTRUCT,WinCrypt.CTL_CONTEXT,WinCrypt.CTL_ENTRY,WinCrypt.CTL_INFO,WinCrypt.CTL_USAGE,WinCrypt.DATA_BLOB,WinDef.POINT,WinDef.RECT,Winevt.EVT_RPC_LOGIN,Winevt.EVT_VARIANT,WinGDI.BITMAP,WinGDI.BITMAPINFO,WinGDI.BITMAPINFOHEADER,WinGDI.DIBSECTION,WinGDI.ICONINFO,WinGDI.PIXELFORMATDESCRIPTOR,WinGDI.RGBQUAD,WinGDI.RGNDATA,WinGDI.RGNDATAHEADER,Wininet.INTERNET_CACHE_ENTRY_INFO,Winioctl.STORAGE_DEVICE_NUMBER,Winnetwk.NETRESOURCE,Winnetwk.REMOTE_NAME_INFO,Winnetwk.UNIVERSAL_NAME_INFO,WinNT.ACE_HEADER,WinNT.ACL,WinNT.BATTERY_REPORTING_SCALE,WinNT.CACHE_DESCRIPTOR,WinNT.EVENTLOGRECORD,WinNT.FILE_NOTIFY_INFORMATION,WinNT.GENERIC_MAPPING,WinNT.GROUP_AFFINITY,WinNT.IO_COUNTERS,WinNT.LARGE_INTEGER,WinNT.LARGE_INTEGER.LowHigh,WinNT.LUID,WinNT.LUID_AND_ATTRIBUTES,WinNT.MEMORY_BASIC_INFORMATION,WinNT.OSVERSIONINFO,WinNT.OSVERSIONINFOEX,WinNT.POWER_ACTION_POLICY,WinNT.PRIVILEGE_SET,WinNT.PROCESSOR_GROUP_INFO,WinNT.PROCESSOR_POWER_INFORMATION,WinNT.PSID,WinNT.SECURITY_DESCRIPTOR,WinNT.SECURITY_DESCRIPTOR_RELATIVE,WinNT.SECURITY_QUALITY_OF_SERVICE,WinNT.SID_AND_ATTRIBUTES,WinNT.SYSTEM_BATTERY_STATE,WinNT.SYSTEM_LOGICAL_PROCESSOR_INFORMATION,WinNT.SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX,WinNT.SYSTEM_LOGICAL_PROCESSOR_INFORMATION.AnonymousStructNumaNode,WinNT.SYSTEM_LOGICAL_PROCESSOR_INFORMATION.AnonymousStructProcessorCore,WinNT.SYSTEM_POWER_CAPABILITIES,WinNT.SYSTEM_POWER_INFORMATION,WinNT.SYSTEM_POWER_LEVEL,WinNT.SYSTEM_POWER_POLICY,WinNT.TOKEN_ELEVATION,WinNT.TOKEN_GROUPS,WinNT.TOKEN_OWNER,WinNT.TOKEN_PRIMARY_GROUP,WinNT.TOKEN_PRIVILEGES,WinNT.TOKEN_USER,WinPerf.PERF_COUNTER_BLOCK,WinPerf.PERF_COUNTER_DEFINITION,WinPerf.PERF_DATA_BLOCK,WinPerf.PERF_INSTANCE_DEFINITION,WinPerf.PERF_OBJECT_TYPE,WinRas.RAS_STATS,WinRas.RASCONN,WinRas.RASCONNSTATUS,WinRas.RASCREDENTIALS,WinRas.RASDEVSPECIFICINFO,WinRas.RASDIALEXTENSIONS,WinRas.RASDIALPARAMS,WinRas.RASEAPINFO,WinRas.RASENTRY,WinRas.RASIPADDR,WinRas.RASIPV4ADDR,WinRas.RASIPV6ADDR,WinRas.RASPPPIP,WinRas.RASTUNNELENDPOINT,Winspool.JOB_INFO_1,Winspool.LPPRINTER_DEFAULTS,Winspool.NOTIFY_DATA_DATA,Winspool.PRINTER_INFO_1,Winspool.PRINTER_INFO_2,Winspool.PRINTER_INFO_4,Winspool.PRINTER_NOTIFY_INFO,Winspool.PRINTER_NOTIFY_INFO_DATA,Winspool.PRINTER_NOTIFY_OPTIONS,Winspool.PRINTER_NOTIFY_OPTIONS_TYPE,Winsvc.ChangeServiceConfig2Info,Winsvc.ENUM_SERVICE_STATUS,Winsvc.ENUM_SERVICE_STATUS_PROCESS,Winsvc.SC_ACTION,Winsvc.SERVICE_STATUS,Winsvc.SERVICE_STATUS_PROCESS,Winsvc.SERVICE_TABLE_ENTRY,WinUser.BLENDFUNCTION,WinUser.COPYDATASTRUCT,WinUser.CWPSTRUCT,WinUser.FLASHWINFO,WinUser.GUITHREADINFO,WinUser.HARDWAREINPUT,WinUser.INPUT,WinUser.KBDLLHOOKSTRUCT,WinUser.KEYBDINPUT,WinUser.LASTINPUTINFO,WinUser.MONITORINFO,WinUser.MONITORINFOEX,WinUser.MOUSEINPUT,WinUser.MSG,WinUser.MSLLHOOKSTRUCT,WinUser.POWERBROADCAST_SETTING,WinUser.RAWINPUTDEVICELIST,WinUser.SIZE,WinUser.WINDOWINFO,WinUser.WINDOWPLACEMENT,WinUser.WNDCLASSEX,Wtsapi32.WTS_CLIENT_ADDRESS,Wtsapi32.WTS_PROCESS_INFO_EX,Wtsapi32.WTS_SESSION_INFO,Wtsapi32.WTSINFO,X11.XAnyEvent,X11.XButtonEvent,X11.XCirculateEvent,X11.XCirculateRequestEvent,X11.XClientMessageEvent,X11.XColormapEvent,X11.XConfigureEvent,X11.XConfigureRequestEvent,X11.XCreateWindowEvent,X11.XCrossingEvent,X11.XDestroyWindowEvent,X11.XDeviceByReference,X11.XErrorEvent,X11.XExposeEvent,X11.XFocusChangeEvent,X11.XGCValues,X11.XGenericEvent,X11.XGenericEventCookie,X11.XGraphicsExposeEvent,X11.XGravityEvent,X11.XInputClassInfoByReference,X11.XKeyboardControlRef,X11.XKeyboardStateRef,X11.XKeyEvent,X11.XKeymapEvent,X11.XMapEvent,X11.XMappingEvent,X11.XMapRequestEvent,X11.XModifierKeymapRef,X11.XMotionEvent,X11.XNoExposeEvent,X11.XPoint,X11.XPropertyEvent,X11.XRectangle,X11.Xrender.XRenderDirectFormat,X11.Xrender.XRenderPictFormat,X11.XReparentEvent,X11.XResizeRequestEvent,X11.XSelectionClearEvent,X11.XSelectionEvent,X11.XSelectionRequestEvent,X11.XSetWindowAttributes,X11.XSizeHints,X11.XSizeHints.Aspect,X11.XTextProperty,X11.XUnmapEvent,X11.XVisibilityEvent,X11.XVisualInfo,X11.XWindowAttributes,X11.XWMHints
struct*. When used as a field within another
Structure, it corresponds to struct. The
tagging interfaces Structure.ByReference and Structure.ByValue may be used
to alter the default behavior. Structures may have variable size, but only
by providing an array field (e.g. byte[]).
See the overview for supported type mappings for struct fields.
Structure alignment and type mappings are derived by default from the
enclosing interface definition (if any) by using
Native.getStructureAlignment(java.lang.Class<?>) and Native.getTypeMapper(java.lang.Class<?>).
Alternatively you can explicitly provide alignment, field order, or type
mapping by calling the respective Structure functions in your subclass's
constructor.
Structure fields corresponding to native struct fields must be public. If your structure is to have no fields of its own, it must be declared abstract.
You must annotate the class with Structure.FieldOrder or implement
getFieldOrder(), whichever you choose it must contain the field names
(Strings) indicating the proper order of the fields. If you chose to implement
getFieldOrder() notice that when dealing with multiple levels of
subclasses of Structure, you must add to the list provided by the superclass
getFieldOrder() the fields defined in the current class.
In the past, most VMs would return them in a predictable order, but the JVM
spec does not require it, so getFieldOrder() is now required to
ensure JNA knows the proper order).
Structure fields may additionally have the following modifiers:
volatileJNA will not write the field unless specifically instructed to do so viawriteField(String). This allows you to prevent inadvertently overwriting memory that may be updated in real time on another (possibly native) thread.finalJNA will overwrite the field viaread(), but otherwise the field is not modifiable from Java. Take care when using this option, since the compiler will usually assume all accesses to the field (for a given Structure instance) have the same value. This modifier is invalid to use on J2ME.
NOTE: Strings are used to represent native C strings because usage of
char * is generally more common than wchar_t *.
You may provide a type mapper (example here) if you prefer to use String in place of WString if
your native code predominantly uses wchar_t *.
NOTE: In general, instances of this class are not synchronized.
- Autor:
- Todd Fast, todd.fast@sun.com, twall@users.sf.net
-
Verschachtelte Klassen - Übersicht
Verschachtelte KlassenModifizierer und TypKlasseBeschreibungstatic interfaceTagging interface to indicate the address of an instance of the Structure type is to be used within aStructuredefinition rather than nesting the full Structure contents.static interfaceTagging interface to indicate the value of an instance of theStructuretype is to be used in function invocations rather than its address.(Package privat) static classThis class auto-generates an ffi_type structure appropriate for a given structure for use by libffi.static @interfaceUsed to declare fields order as metadata instead of method.protected static class(Package privat) static classAvoid using a hash-based implementation since the hash code for a Structure is not immutable. -
Feldübersicht
FelderModifizierer und TypFeldBeschreibungstatic final intUse the platform default alignment.static final intvalidated for 32-bit x86 linux/gcc; align field size, max 4 bytesstatic final intvalidated for w32/msvc; align on field sizestatic final intNo alignment, place all fields on nearest 1-byte boundaryprotected static final intAlign to an 8-byte boundary.(Package privat) static final ReentrantReadWriteLock(Package privat) static final ReentrantReadWriteLock(Package privat) static final ReentrantReadWriteLock(Package privat) static final ReentrantReadWriteLock -
Konstruktorübersicht
KonstruktorenModifiziererKonstruktorBeschreibungprotectedprotectedStructure(int alignType) protectedStructure(int alignType, TypeMapper mapper) protectedCreate a structure cast onto pre-allocated memory.protectedprotectedStructure(Pointer p, int alignType, TypeMapper mapper) protectedStructure(TypeMapper mapper) -
Methodenübersicht
Modifizierer und TypMethodeBeschreibungprotected voidAttempt to allocate memory if sufficient information is available.protected voidallocateMemory(int size) Provided for derived classes to indicate a different size than the default.protected MemoryautoAllocate(int size) Obtain auto-allocated memory for use with struct represenations.voidautoRead()static voidvoidstatic voidbusy()protected voidCache native type information for use in native code.protected intcalculateSize(boolean force) Calculate the amount of native memory required for this structure.(Package privat) intcalculateSize(boolean force, boolean avoidFFIType) voidclear()Clears the native memory associated with this Structure.(Package privat) voidPerforms auto-read only if uninitialized.createFieldsOrder(String field) createFieldsOrder(String... fields) createFieldsOrder(List<String> baseFields, String... extraFields) createFieldsOrder(List<String> baseFields, List<String> extraFields) booleanReturn whether the given Structure's native backing data is identical to this one.booleandataEquals(Structure s, boolean clear) Return whether the given Structure's backing data is identical to this one, optionally clearing and re-writing native memory before checking.protected voidEnsure this memory has its size and layout calculated and its memory allocated.booleanprotected intfieldOffset(String name) Returns the calculated offset of the given field.(Package privat) Map<String, Structure.StructField> fields()Return all fields in this structure (ordered).booleanReturns whether the structure is read from native memory after a native function call.booleanReturns whether the structure is written to native memory prior to a native function call.Look up all fields in this class and superclasses.Returns this Structure's field names in their proper order.
When defining a newStructureyou shouldn't override this method, but useStructure.FieldOrderannotation to define your field order(this also works with inheritance)
If you want to do something non-standard you can override the method and define it as followedgetFields(boolean force) Returns all field names (sorted) provided so far bygetFieldOrder()(Package privat) Structure.FFITypeOverride to supply native type information for the given field.(Package privat) ObjectgetFieldValue(Field field) Obtain the value currently in the Java field.protected intgetNativeAlignment(Class<?> type, Object value, boolean isFirstElement) Overridable in subclasses.protected intgetNativeSize(Class<?> nativeType) Return the native size of the given Java type, from the perspective of this Structure.protected intgetNativeSize(Class<?> nativeType, Object value) Return the native size of the given Java type, from the perspective of this Structure.Return aPointerobject to this structure.protected StringEncoding to use to convertStringto nativeconst char*.protected int(Package privat) Pointer(Package privat) static Structure.FFITypegetTypeInfo(Object obj) Exposed for testing purposes only.(Package privat) TypeMapperinthashCode()static <T extends Structure>
TnewInstance(Class<T> type) Create a new Structure instance of the given typestatic <T extends Structure>
TnewInstance(Class<T> type, Pointer init) Create a new Structure instance of the given type, initialized with the given memory.voidread()Reads the fields of the struct from native memoryprotected ObjectreadField(Structure.StructField structField) Read the given field and return its value.Force a read of the given field from native memory.reading()protected voidsetAlignType(int alignType) Change the alignment of this structure.voidsetAutoRead(boolean auto) Set whether the structure is read from native memory after a native function call.voidsetAutoSynch(boolean auto) Set whether the structure is automatically synchronized to native memory before and after a native function call.voidsetAutoWrite(boolean auto) Set whether the structure is written to native memory prior to a native function call.(Package privat) voidsetFieldValue(Field field, Object value) protected voidsetStringEncoding(String encoding) Set the desired encoding to use when writing String fields to native memory.intsize()Returns the size in memory occupied by this Structure.(Package privat) static intEfficiently calculate the size of the given Structure subclass.(Package privat) static <T extends Structure>
intEfficiently calculate the size of the given Structure subclass.protected voidsortFields(List<Field> fields, List<String> names) Sort the structure fields according to the given array of names.toArray(int size) Returns a view of this structure's memory as an array of structures.Returns a view of this structure's memory as an array of structures.toString()Ifjna.dump_memoryis true, will include a native memory dump of the Structure's backing memory.toString(boolean debug) (Package privat) static <T extends Structure>
TupdateStructureByReference(Class<T> type, T s, Pointer address) Only keep the original structure if its native address is unchanged.protected voidSet the memory used by this structure.protected voidSet the memory used by this structure.(Package privat) voidSet the memory used by this structure.(Package privat) static voidIndicate whether the given Structure class can be created by JNA.voidwrite()Writes the fields of the struct to native memoryprotected voidwriteField(Structure.StructField structField) voidwriteField(String name) Write the given field to native memory.voidwriteField(String name, Object value) Write the given field value to the field and native memory.
-
Felddetails
-
ALIGN_DEFAULT
public static final int ALIGN_DEFAULTUse the platform default alignment.- Siehe auch:
-
ALIGN_NONE
public static final int ALIGN_NONENo alignment, place all fields on nearest 1-byte boundary- Siehe auch:
-
ALIGN_GNUC
public static final int ALIGN_GNUCvalidated for 32-bit x86 linux/gcc; align field size, max 4 bytes- Siehe auch:
-
ALIGN_MSVC
public static final int ALIGN_MSVCvalidated for w32/msvc; align on field size- Siehe auch:
-
CALCULATE_SIZE
protected static final int CALCULATE_SIZEAlign to an 8-byte boundary.- Siehe auch:
-
layoutInfoLock
-
fieldOrderLock
-
fieldListLock
-
validationLock
-
layoutInfo
-
fieldOrder
-
fieldList
-
validationMap
-
-
Konstruktordetails
-
Structure
protected Structure() -
Structure
-
Structure
protected Structure(int alignType) -
Structure
-
Structure
Create a structure cast onto pre-allocated memory. -
Structure
-
Structure
-
-
Methodendetails
-
fields
Map<String,Structure.StructField> fields()Return all fields in this structure (ordered). This represents the layout of the structure, and will be shared among Structures of the same class except when the Structure can have a variable size. NOTE:ensureAllocated()must be called prior to calling this method.- Gibt zurück:
Mapof field names to field representations.
-
getTypeMapper
TypeMapper getTypeMapper()- Gibt zurück:
- the type mapper in effect for this Structure.
-
setStringEncoding
Set the desired encoding to use when writing String fields to native memory.- Parameter:
encoding- desired encoding
-
getStringEncoding
Encoding to use to convertStringto nativeconst char*. Defaults toNative.getDefaultStringEncoding().- Gibt zurück:
- Current encoding
-
setAlignType
protected void setAlignType(int alignType) Change the alignment of this structure. Re-allocates memory if necessary. If alignment isALIGN_DEFAULT, the default alignment for the defining class will be used.- Parameter:
alignType- desired alignment type
-
autoAllocate
Obtain auto-allocated memory for use with struct represenations.- Parameter:
size- desired size- Gibt zurück:
- newly-allocated memory
-
useMemory
Set the memory used by this structure. This method is used to indicate the given structure is nested within another or otherwise overlaid on some other memory block and thus does not own its own memory.- Parameter:
m- Memory to with which to back thisStructure.
-
useMemory
Set the memory used by this structure. This method is used to indicate the given structure is based on natively-allocated data, nested within another, or otherwise overlaid on existing memory and thus does not own its own memory allocation.- Parameter:
m- Base memory to use to back this structure.offset- offset into provided memory where structure mapping should start.
-
useMemory
Set the memory used by this structure. This method is used to indicate the given structure is based on natively-allocated data, nested within another, or otherwise overlaid on existing memory and thus does not own its own memory allocation.- Parameter:
m- Native pointeroffset- offset from pointer to useforce- ByValue structures normally ignore requests to use a different memory offset; this input is settruewhen setting a ByValue struct that is nested within another struct.
-
ensureAllocated
protected void ensureAllocated()Ensure this memory has its size and layout calculated and its memory allocated. -
allocateMemory
protected void allocateMemory()Attempt to allocate memory if sufficient information is available. Returns whether the operation was successful. -
allocateMemory
protected void allocateMemory(int size) Provided for derived classes to indicate a different size than the default. Returns whether the operation was successful. Will leave memory untouched if it is non-null and not allocated by this class.- Parameter:
size- how much memory to allocate
-
size
public int size()Returns the size in memory occupied by this Structure.- Gibt zurück:
- Native size of this structure, in bytes.
-
clear
public void clear()Clears the native memory associated with this Structure. -
getPointer
Return aPointerobject to this structure. Note that if you use the structure's pointer as a function argument, you are responsible for callingwrite()prior to the call andread()after the call. These calls are normally handled automatically by theFunctionobject when it encounters aStructureargument or return value. The returned pointer may not have meaning forStructure.ByValuestructure representations.- Gibt zurück:
- Native pointer representation of this structure.
-
busy
-
reading
-
conditionalAutoRead
void conditionalAutoRead()Performs auto-read only if uninitialized. -
read
public void read()Reads the fields of the struct from native memory -
fieldOffset
Returns the calculated offset of the given field.- Parameter:
name- field to examine- Gibt zurück:
- return offset of the given field
-
readField
Force a read of the given field from native memory. The Java field will be updated from the current contents of native memory.- Parameter:
name- field to be read- Gibt zurück:
- the new field value, after updating
- Löst aus:
IllegalArgumentException- if no field exists with the given name
-
getFieldValue
Obtain the value currently in the Java field. Does not read from native memory.- Parameter:
field- field to look up- Gibt zurück:
- current field value (Java-side only)
-
setFieldValue
- Parameter:
field- field to setvalue- value to set
-
updateStructureByReference
Only keep the original structure if its native address is unchanged. Otherwise replace it with a new object.- Parameter:
type- Structure subclasss- Original Structure objectaddress- the nativestruct *- Gibt zurück:
- Updated
Structure.ByReferenceobject
-
readField
Read the given field and return its value. The Java field will be updated from the contents of native memory.- Parameter:
structField- field to be read- Gibt zurück:
- value of the requested field
-
write
public void write()Writes the fields of the struct to native memory -
writeField
Write the given field to native memory. The current value in the Java field will be translated into native memory.- Parameter:
name- which field to synch- Löst aus:
IllegalArgumentException- if no field exists with the given name
-
writeField
Write the given field value to the field and native memory. The given value will be written both to the Java field and the corresponding native memory.- Parameter:
name- field to writevalue- value to write- Löst aus:
IllegalArgumentException- if no field exists with the given name
-
writeField
- Parameter:
structField- internal field representation to synch to native memory
-
getFieldOrder
Returns this Structure's field names in their proper order.
When defining a newStructureyou shouldn't override this method, but useStructure.FieldOrderannotation to define your field order(this also works with inheritance)
If you want to do something non-standard you can override the method and define it as followed
IMPORTANT When deriving from an existing Structure subclass, ensure that you augment the list provided by the superclass, e.g.protected ListgetFieldOrder() { return Arrays.asList(...); }
Field order must be explicitly indicated, since the field order as returned byprotected ListgetFieldOrder() { List fields = new LinkedList (super.getFieldOrder()); fields.addAll(Arrays.asList(...)); return fields; } Class.getFields()is not guaranteed to be predictable.- Gibt zurück:
- ordered list of field names
-
sortFields
Sort the structure fields according to the given array of names.- Parameter:
fields- list of fields to be sortednames- list of names representing the desired sort order
-
getFieldList
Look up all fields in this class and superclasses. -
createFieldsOrder
-
createFieldsOrder
-
createFieldsOrder
- Parameter:
field- The (single) field name- Gibt zurück:
- @return An un-modifiable list containing the field name
-
createFieldsOrder
- Parameter:
fields- The structure field names in correct order- Gibt zurück:
- An un-modifiable list of the fields
-
getFields
Returns all field names (sorted) provided so far bygetFieldOrder()- Parameter:
force- set if results are required immediately- Gibt zurück:
- null if not yet able to provide fields, and force is false.
- Löst aus:
Error- if force is true and field order data not yet specified and can't be generated automatically.
-
calculateSize
protected int calculateSize(boolean force) Calculate the amount of native memory required for this structure. May returnCALCULATE_SIZEif the size can not yet be determined (usually due to fields in the derived class not yet being initialized). If theforceparameter istruewill throw anIllegalStateExceptionif the size can not be determined.- Parameter:
force- whether to force size calculation- Gibt zurück:
- calculated size, or
CALCULATE_SIZEif the size can not yet be determined. - Löst aus:
IllegalStateException- an array field is not initialized or the size can not be determined whileforceistrue.IllegalArgumentException- when an unsupported field type is encountered
-
size
Efficiently calculate the size of the given Structure subclass.- Parameter:
type- Structure subclass to check- Gibt zurück:
- native size of the given Structure subclass
-
size
Efficiently calculate the size of the given Structure subclass.- Parameter:
type- Structure subclass to checkvalue- optional instance of the given class- Gibt zurück:
- native size of the Structure subclass
-
calculateSize
int calculateSize(boolean force, boolean avoidFFIType) - Parameter:
force- whether to force size calculation.avoidFFIType- set false in certain situations to avoid recursive type lookup.- Gibt zurück:
- calculated size, or
CALCULATE_SIZEif there is not yet enough information to perform the size calculation.
-
getStructAlignment
protected int getStructAlignment()- Gibt zurück:
- current alignment setting for this structure
-
getNativeAlignment
Overridable in subclasses. Calculate the appropriate alignment for a field of a given type within this struct.- Parameter:
type- field typevalue- field value, if availableisFirstElement- is this field the first element in the struct?- Gibt zurück:
- the native byte alignment
-
toString
Ifjna.dump_memoryis true, will include a native memory dump of the Structure's backing memory. -
toString
- Parameter:
debug- If true, will include a native memory dump of the Structure's backing memory.- Gibt zurück:
- String representation of this object.
-
toArray
Returns a view of this structure's memory as an array of structures. Note that thisStructuremust have a public, no-arg constructor. If the structure is currently using auto-allocatedMemorybacking, the memory will be resized to fit the entire array.- Parameter:
array- Structure[] object to populate- Gibt zurück:
- array of Structure mapped onto the available memory
-
toArray
Returns a view of this structure's memory as an array of structures. Note that thisStructuremust have a public, no-arg constructor. If the structure is currently using auto-allocatedMemorybacking, the memory will be resized to fit the entire array.- Parameter:
size- desired number of elements- Gibt zurück:
- array of Structure (individual elements will be of the appropriate type, as will the Structure[]).
-
dataEquals
Return whether the given Structure's native backing data is identical to this one.- Parameter:
s- Structure to compare- Gibt zurück:
- equality result
-
dataEquals
Return whether the given Structure's backing data is identical to this one, optionally clearing and re-writing native memory before checking.- Parameter:
s- Structure to compareclear- whether to clear native memory- Gibt zurück:
- equality result
-
equals
-
hashCode
public int hashCode() -
cacheTypeInfo
Cache native type information for use in native code.- Parameter:
p- Native pointer to the type information
-
getFieldTypeInfo
Override to supply native type information for the given field.- Parameter:
f- internal field representation- Gibt zurück:
- Native pointer to the corresponding type information
-
getTypeInfo
Pointer getTypeInfo()- Gibt zurück:
- native type information for this structure.
-
setAutoSynch
public void setAutoSynch(boolean auto) Set whether the structure is automatically synchronized to native memory before and after a native function call. Convenience method for
For extremely large or complex structures where you only need to access a small number of fields, you may see a significant performance benefit by avoiding automatic structure reads and writes. If auto-read and -write are disabled, it is up to you to ensure that the Java fields of interest are synched before and after native function calls viaboolean auto = ...; setAutoRead(auto); setAutoWrite(auto);readField(String)andwriteField(String,Object). This is typically most effective when a native call populates a large structure and you only need a few fields out of it. After the native call you can callreadField(String)on only the fields of interest.- Parameter:
auto- whether to automatically synch with native memory.
-
setAutoRead
public void setAutoRead(boolean auto) Set whether the structure is read from native memory after a native function call.- Parameter:
auto- whether to automatically synch from native memory.
-
getAutoRead
public boolean getAutoRead()Returns whether the structure is read from native memory after a native function call.- Gibt zurück:
- whether automatic synch from native memory is enabled.
-
setAutoWrite
public void setAutoWrite(boolean auto) Set whether the structure is written to native memory prior to a native function call.- Parameter:
auto- whether to automatically synch to native memory.
-
getAutoWrite
public boolean getAutoWrite()Returns whether the structure is written to native memory prior to a native function call.- Gibt zurück:
- whether automatic synch to native memory is enabled.
-
getTypeInfo
Exposed for testing purposes only.- Parameter:
obj- object to query- Gibt zurück:
- native pointer to type information
-
newInstance
public static <T extends Structure> T newInstance(Class<T> type, Pointer init) throws IllegalArgumentException Create a new Structure instance of the given type, initialized with the given memory.- Parameter:
type- desired Structure typeinit- initial memory- Gibt zurück:
- the new instance
- Löst aus:
IllegalArgumentException- if the instantiation fails
-
newInstance
Create a new Structure instance of the given type- Parameter:
type- desired Structure type- Gibt zurück:
- the new instance
- Löst aus:
IllegalArgumentException- if the instantiation fails
-
autoRead
-
autoRead
public void autoRead() -
autoWrite
-
autoWrite
public void autoWrite() -
getNativeSize
Return the native size of the given Java type, from the perspective of this Structure.- Parameter:
nativeType- field type to examine- Gibt zurück:
- native size (in bytes) of the requested field type
-
getNativeSize
Return the native size of the given Java type, from the perspective of this Structure.- Parameter:
nativeType- field type to examinevalue- instance of the field type- Gibt zurück:
- native size (in bytes) of the requested field type
-
validate
Indicate whether the given Structure class can be created by JNA.- Parameter:
cls- Structure subclass to check
-