Package com.io7m.waxmill.machines

# Interface WXMCPUTopologyType

All Known Implementing Classes:
  `WXMCPUTopology`

    @Immutable
    public interface WXMCPUTopologyType

The CPU topology for the virtual machine. The default value for each of cpus, sockets, cores, and threads is 1. The current maximum number of guest virtual CPUs is 16. If cpus is not specified then it will be calculated from the other arguments. The topology must be consistent in that the cpus must equal the product of sockets, cores, and threads. If a setting is specified more than once the last one has precedence.

- ## Nested Class Summary

  Nested Classes
  Modifier and Type | Interface | Description
  --- | --- | ---
  `static interface` | `WXMCPUTopologyType.WXMPinCPUType` | A description of a CPU pin.

- ## Method Summary

  Modifier and Type | Method | Description
  --- | --- | ---
  `default void` | `checkPreconditions()` | Check preconditions for the type.
  `default java.lang.String` | `comment()` |
  `default int` | `cores()` |
  `default int` | `cpus()` |
  `java.util.List<WXMPinCPU>` | `pinnedCPUs()` |
  `default int` | `sockets()` |
  `default int` | `threads()` |

- ## Method Details

  - ### sockets

    @Default default int sockets()
    Returns:
      The number of sockets

  - ### threads

    @Default default int threads()
    Returns:
      The number of threads per core

  - ### cores

    @Default default int cores()
    Returns:
      The number of cores per socket

  - ### cpus

    @Default default int cpus()
    Returns:
      The total number of CPU elements

  - ### comment

    @Default default java.lang.String comment()
    Returns:
      A descriptive comment

  - ### pinnedCPUs

    java.util.List<WXMPinCPU> pinnedCPUs()
    Returns:
      The list of CPU pinning instructions

  - ### checkPreconditions

    @Check default void checkPreconditions()
    Check preconditions for the type.