li.cil.oc.api.machine

Interface MachineHost

All Superinterfaces:

EnvironmentHost

public interface MachineHost
extends EnvironmentHost

This interface has to be implemented by 'hosts' of machine instances.

It provides some context for the machine, in particular which world it is running in, to allow querying the time of day, for example.

Method Summary

Methods

Modifier and Type	Method and Description
double	callBudget() This determines how many direct calls the machine can make per tick.
int	componentSlot(java.lang.String address) Get the slot a component with the specified address is in.
java.lang.Class<? extends Architecture>	cpuArchitecture() Get the architecture to use in the hosted machine.
int	installedMemory() The amount of memory (RAM) made available to the machine, in bytes.
void	markForSaving() This is called by the machine when its state changed (which can be multiple times per actual game tick), to notify the owner that it should save its state on the next world save.
int	maxComponents() The number of components the machine can address without crashing.
void	onMachineConnect(Node node) This is called on the owner when the machine's Environment.onConnect(Node) method gets called.
void	onMachineDisconnect(Node node) Like onMachineConnect(Node), except that this is called whenever the machine's Environment.onDisconnect(Node) method is called.

Methods inherited from interface li.cil.oc.api.driver.EnvironmentHost

markChanged, world, xPosition, yPosition, zPosition

Method Detail

cpuArchitecture

java.lang.Class<? extends Architecture> cpuArchitecture()

Get the architecture to use in the hosted machine.

This can be a static architecture type, but will usually be based on the CPU installed in the host (for example, this is true for computer cases, servers, robots and tablets).

Returns:

the architecture of the installed CPU, or null.

callBudget

double callBudget()

This determines how many direct calls the machine can make per tick.

A call to a direct method with a limit will consume 1 / limit of the available call budget. When the budget reaches zero, the machine is forced into a synchronized call to make it wait for the next tick.

The default values used by OC are 0.5, 1.0 and 1.5 for a tier one, two and three CPU, respectively.

The call budget is reset to this value each tick.

Returns:

the direct call budget, per tick.

installedMemory

int installedMemory()

The amount of memory (RAM) made available to the machine, in bytes.

This is usually determined by the components installed in the owner, for example the memory sticks in a computer case.

Returns:

the amount of memory that can be used by the machine, in bytes.

maxComponents

int maxComponents()

The number of components the machine can address without crashing.

This is usually determined by the components installed in the owner, for example the CPUs in a server.

Note that the component count does not include file systems.

Returns:

the number of supported components.

componentSlot

int componentSlot(java.lang.String address)

Get the slot a component with the specified address is in.

This is intended to allow determining the slot of item components sitting in computers. For other components this returns negative values.

Parameters:

address - the address of the component to get the slot for.

Returns:

the index of the slot the component is in.

markForSaving

void markForSaving()

This is called by the machine when its state changed (which can be multiple times per actual game tick), to notify the owner that it should save its state on the next world save.

This method is called from executor threads, so it must be thread-safe.

onMachineConnect

void onMachineConnect(Node node)

This is called on the owner when the machine's Environment.onConnect(Node) method gets called. This can be useful for reacting to network events when the owner does not have its own node (for example, computer cases expose their machine's node as their own node). This callback allows it to connect its components (graphics cards and the like) when it is connected to a node network (when added to the world, for example).

Parameters:

node - the node that was connected to the network.

onMachineDisconnect

void onMachineDisconnect(Node node)

Like onMachineConnect(Node), except that this is called whenever the machine's Environment.onDisconnect(Node) method is called.

Parameters:

node - the node that was disconnected from the network.