net.openhft.chronicle.core

Enum OS

java.lang.Object

java.lang.Enum<OS>

net.openhft.chronicle.core.OS

All Implemented Interfaces:

Serializable, Comparable<OS>

public enum OS
extends Enum<OS>

Low level access to OS class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OS.Unmapper

Field Summary

Fields

Modifier and Type	Field and Description
static String	TARGET Deprecated.
static Exception	TIME_LIMIT
static String	TMP
static String	USER_DIR
static String	USER_HOME

Method Summary

Modifier and Type	Method and Description
static String	findDir(String suffix)
static File	findFile(String... path) Search a list of directories to find a path which is the last element.
static String	getHostName()
static long	getPidMax()
static int	getProcessId()
static String	getTarget()
static String	getUserName()
static boolean	is64Bit()
static boolean	isLinux()
static boolean	isMacOSX()
static boolean	isWindows() This may or may not be the OS thread id, but should be unique across processes
static long	map(FileChannel fileChannel, FileChannel.MapMode mode, long start, long size) Map a region of a file into memory.
static long	mapAlign(long offset) Align an offset of a memory mapping in file based on OS.
static long	mapAlignment() Returns the alignment of offsets in file, from which memory mapping could start, based on OS.
static Memory	memory()
static long	memoryMapped()
static long	pageAlign(long size) Align the size to page boundary
static int	pageSize()
static int	read0(FileDescriptor fd, long address, int len)
static long	spaceUsed(String filename) Get the space actually used by a file.
static void	unmap(long address, long size) Unmap a region of memory.
static String	userDir()
static OS	valueOf(String name) Returns the enum constant of this type with the specified name.
static OS[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
static int	write0(FileDescriptor fd, long address, int len)

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

TMP

public static final String TMP

USER_DIR

public static final String USER_DIR

USER_HOME

public static final String USER_HOME

TIME_LIMIT

public static final Exception TIME_LIMIT

TARGET

@Deprecated
public static final String TARGET

Deprecated.

Method Detail

values

public static OS[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (OS c : OS.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static OS valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

findDir

@NotNull
public static String findDir(@NotNull
                                      String suffix)
                               throws FileNotFoundException

Throws:

FileNotFoundException

findFile

@NotNull
public static File findFile(@NotNull
                                     String... path)

Search a list of directories to find a path which is the last element.

Parameters:

path - of directories to use if found, the last path is always appended.

Returns:

the resulting File path.

getHostName

public static String getHostName()

getUserName

public static String getUserName()

getTarget

public static String getTarget()

memory

@NotNull
public static Memory memory()

Returns:

native memory accessor class

pageAlign

public static long pageAlign(long size)

Align the size to page boundary

Parameters:

size - the size to align

Returns:

aligned size

See Also:

pageSize()

pageSize

public static int pageSize()

Returns:

size of pages

See Also:

pageAlign(long)

mapAlign

public static long mapAlign(long offset)

Align an offset of a memory mapping in file based on OS.

Parameters:

offset - to align

Returns:

offset aligned

See Also:

mapAlignment()

mapAlignment

public static long mapAlignment()

Returns the alignment of offsets in file, from which memory mapping could start, based on OS.

Returns:

granularity of an offset in a file

See Also:

mapAlign(long)

is64Bit

public static boolean is64Bit()

Returns:

is the JVM 64-bit

getProcessId

public static int getProcessId()

isWindows

public static boolean isWindows()

This may or may not be the OS thread id, but should be unique across processes

Returns:

a unique tid of up to 48 bits.

isMacOSX

public static boolean isMacOSX()

isLinux

public static boolean isLinux()

getPidMax

public static long getPidMax()
                      throws NumberFormatException

Returns:

the maximum PID.

Throws:

NumberFormatException

map

public static long map(@NotNull
                       FileChannel fileChannel,
                       FileChannel.MapMode mode,
                       long start,
                       long size)
                throws IOException,
                       IllegalArgumentException

Map a region of a file into memory.

Parameters:

fileChannel - to map

mode - of access

start - offset within a file

size - of region to map.

Returns:

the address of the memory mapping.

Throws:

IOException - if the mapping fails

IllegalArgumentException - if the arguments are not valid

unmap

public static void unmap(long address,
                         long size)
                  throws IOException

Unmap a region of memory.

Parameters:

address - of the start of the mapping.

size - of the region mapped.

Throws:

IOException - if the unmap fails.

memoryMapped

public static long memoryMapped()

spaceUsed

public static long spaceUsed(@NotNull
                             String filename)

Get the space actually used by a file.

Parameters:

filename - to get the actual size of

Returns:

size in bytes.

userDir

public static String userDir()

read0

public static int read0(FileDescriptor fd,
                        long address,
                        int len)
                 throws IOException

Throws:

IOException

write0

public static int write0(FileDescriptor fd,
                         long address,
                         int len)
                  throws IOException

Throws:

IOException