Class CaptureControlClient

java.lang.Object

com.shaft.capture.control.CaptureControlClient

public final class CaptureControlClient
extends Object

Authenticated client for a detached local capture recorder.

Constructor Summary

Constructors

Constructor	Description
CaptureControlClient(Path runtimeDirectory)	Creates a client for one runtime directory.

Method Summary

Modifier and Type	Method	Description
CaptureStatus	checkpoint(String description, Checkpoint.CheckpointKind kind)	Adds a checkpoint to the active recorder.
CaptureStatus	status()	Returns active endpoint status or the final local status snapshot.
CaptureStatus	stop(boolean discard)	Stops the active recorder.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CaptureControlClient

public CaptureControlClient(Path runtimeDirectory)

Creates a client for one runtime directory.

Parameters:

runtimeDirectory - local runtime directory

Method Details

status

public CaptureStatus status()

Returns active endpoint status or the final local status snapshot.

Returns:

safe status

checkpoint

public CaptureStatus checkpoint(String description,
 Checkpoint.CheckpointKind kind)

Adds a checkpoint to the active recorder.

Parameters:

description - checkpoint description

kind - checkpoint kind

Returns:

updated status

stop

public CaptureStatus stop(boolean discard)

Stops the active recorder.

Parameters:

discard - whether to delete capture artifacts

Returns:

final status