oshi.jna.platform.mac

Interface DiskArbitration

All Superinterfaces:

com.sun.jna.Library

public interface DiskArbitration
extends com.sun.jna.Library

DiskArbitration framework for disk stats. This class should be considered non-API as it may be removed if/when its code is incorporated into the JNA project.

Author:

widdis[at]gmail[dot]com

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DiskArbitration.DADiskRef
static class	DiskArbitration.DASessionRef

Nested classes/interfaces inherited from interface com.sun.jna.Library

com.sun.jna.Library.Handler

Field Summary

Fields

Modifier and Type	Field and Description
static DiskArbitration	INSTANCE

Fields inherited from interface com.sun.jna.Library

OPTION_ALLOW_OBJECTS, OPTION_CALLING_CONVENTION, OPTION_CLASSLOADER, OPTION_FUNCTION_MAPPER, OPTION_INVOCATION_MAPPER, OPTION_OPEN_FLAGS, OPTION_STRING_ENCODING, OPTION_STRUCTURE_ALIGNMENT, OPTION_TYPE_MAPPER

Method Summary

Modifier and Type	Method and Description
CoreFoundation.CFDictionaryRef	DADiskCopyDescription(DiskArbitration.DADiskRef disk) Obtains the Disk Arbitration description of the specified disk.
DiskArbitration.DADiskRef	DADiskCreateFromBSDName(CoreFoundation.CFAllocatorRef allocator, DiskArbitration.DASessionRef session, String diskName) Creates a new disk object.
DiskArbitration.DADiskRef	DADiskCreateFromIOMedia(CoreFoundation.CFAllocatorRef allocator, DiskArbitration.DASessionRef session, int media) Creates a new disk object.
String	DADiskGetBSDName(DiskArbitration.DADiskRef disk) Obtains the BSD device name for the specified disk.
DiskArbitration.DASessionRef	DASessionCreate(CoreFoundation.CFAllocatorRef allocator) Creates a new session.

Field Detail

INSTANCE

static final DiskArbitration INSTANCE

Method Detail

DASessionCreate

DiskArbitration.DASessionRef DASessionCreate(CoreFoundation.CFAllocatorRef allocator)

Creates a new session. The caller of this function receives a reference to the returned object. The caller also implicitly retains the object and is responsible for releasing it with CFRelease().

Parameters:

allocator - The allocator object to be used to allocate memory.

Returns:

A reference to a new DASession.

DADiskCreateFromBSDName

DiskArbitration.DADiskRef DADiskCreateFromBSDName(CoreFoundation.CFAllocatorRef allocator,
                                                  DiskArbitration.DASessionRef session,
                                                  String diskName)

Creates a new disk object. The caller of this function receives a reference to the returned object. The caller also implicitly retains the object and is responsible for releasing it with CFRelease().

Parameters:

allocator - The allocator object to be used to allocate memory.

session - The DASession in which to contact Disk Arbitration.

diskName - he BSD device name.

Returns:

A reference to a new DADisk.

DADiskCreateFromIOMedia

DiskArbitration.DADiskRef DADiskCreateFromIOMedia(CoreFoundation.CFAllocatorRef allocator,
                                                  DiskArbitration.DASessionRef session,
                                                  int media)

Creates a new disk object. The caller of this function receives a reference to the returned object. The caller also implicitly retains the object and is responsible for releasing it with CFRelease().

Parameters:

allocator - The allocator object to be used to allocate memory.

session - The DASession in which to contact Disk Arbitration.

media - The I/O Kit media object.

Returns:

A reference to a new DADisk.

DADiskCopyDescription

CoreFoundation.CFDictionaryRef DADiskCopyDescription(DiskArbitration.DADiskRef disk)

Obtains the Disk Arbitration description of the specified disk. This function will contact Disk Arbitration to acquire the latest description of the specified disk, unless this function is called on a disk object passed within the context of a registered callback, in which case the description is current as of that callback event. The caller of this function receives a reference to the returned object. The caller also implicitly retains the object and is responsible for releasing it with CFRelease().

Parameters:

disk - The DADisk for which to obtain the Disk Arbitration description.

Returns:

The disk's Disk Arbitration description.

DADiskGetBSDName

String DADiskGetBSDName(DiskArbitration.DADiskRef disk)

Obtains the BSD device name for the specified disk.

Parameters:

disk - The DADisk for which to obtain the BSD device name.

Returns:

The disk's BSD device name.