com.agisoft.metashape

Class NetworkClient

java.lang.Object

com.agisoft.metashape.NetworkClient

All Implemented Interfaces:

java.lang.AutoCloseable

public class NetworkClient
extends java.lang.Object
implements java.lang.AutoCloseable

NetworkClient class provides access to the network processing server and allows
to create and manage tasks.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NetworkClient.BatchInfo
static class	NetworkClient.BatchItem
static class	NetworkClient.BatchList
static class	NetworkClient.OutputRecord
static class	NetworkClient.ResourceRecord
static class	NetworkClient.ServerInfo
static class	NetworkClient.ServerVersion
static class	NetworkClient.State
static class	NetworkClient.TaskInfo
static class	NetworkClient.WorkerInfo
static class	NetworkClient.WorkerItem
static class	NetworkClient.WorkerList

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	swigCMemOwn

Constructor Summary

Constructors

Modifier	Constructor and Description
	NetworkClient()
protected	NetworkClient(long cPtr, boolean cMemoryOwn)

Method Summary

Modifier and Type	Method and Description
void	abortBatch(int batch_id) Abort batch.
void	abortWorker(int worker_id) Abort worker.
void	close()
boolean	connect(java.lang.String host, int port) Connect to the server.
int	createBatch(java.lang.String path, NetworkTask[] tasks, java.util.Map<java.lang.String,java.lang.String> meta) Create new batch.
void	delete()
void	disconnect() Disconnect from the server.
java.lang.String	exportBatches(int[] batch_ids) Export current state of batches.
protected void	finalize()
int	findBatch(java.lang.String path) Get batch id based on project path.
NetworkClient.BatchInfo	getBatchInfo(int batch_id, long revision) Get batch information.
NetworkClient.BatchList	getBatchList(long revision) Get list of batches.
protected static long	getCPtr(NetworkClient obj)
NetworkClient.ServerInfo	getServerInfo(long revision) Get server information.
NetworkClient.ServerVersion	getServerVersion() Get server version.
NetworkClient.WorkerInfo	getWorkerInfo(int worker_id, long revision) Get worker information.
NetworkClient.WorkerList	getWorkerList(long revision) Get list of workers.
void	importBatches(java.lang.String data) Import batches from exported data.
void	quitWorker(int worker_id) Quit worker.
void	setBatchPaused(int batch_id, boolean paused) Set batch paused state.
void	setBatchPriority(int batch_id, int priority) Set batch priority.
void	setBatchWorkerLimit(int batch_id, int worker_limit) Set worker limit of the batch.
void	setMasterServer(java.lang.String hostname) Set master server.
void	setWorkerCapability(int worker_id, int capability) Set worker capability.
void	setWorkerCpuEnabled(int worker_id, boolean cpu_enabled) Set worker CPU enabled flag.
void	setWorkerGpuMask(int worker_id, long gpu_mask) Set worker GPU mask.
void	setWorkerPaused(int worker_id, boolean paused) Set worker paused state.
void	setWorkerPriority(int worker_id, int priority) Set worker priority.

Methods inherited from class java.lang.Object

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

Field Detail

swigCMemOwn

protected transient boolean swigCMemOwn

Constructor Detail

NetworkClient

protected NetworkClient(long cPtr,
                        boolean cMemoryOwn)

NetworkClient

public NetworkClient()

Method Detail

getCPtr

protected static long getCPtr(NetworkClient obj)

finalize

protected void finalize()

Overrides:

finalize in class java.lang.Object

delete

public void delete()

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

connect

public boolean connect(java.lang.String host,
                       int port)

Connect to the server.

Parameters:

host - Server hostname.

port - Communication port.

disconnect

public void disconnect()

Disconnect from the server.

createBatch

public int createBatch(java.lang.String path,
                       NetworkTask[] tasks,
                       java.util.Map<java.lang.String,java.lang.String> meta)

Create new batch.

Parameters:

path - Project path relative to root folder.

tasks - List of processing tasks to execute.

meta - Batch metadata.

Returns:

Batch id.

findBatch

public int findBatch(java.lang.String path)

Get batch id based on project path.

Parameters:

path - Project path relative to root folder.

Returns:

Batch id.

abortBatch

public void abortBatch(int batch_id)

Abort batch.

Parameters:

batch_id - Batch id.

setBatchPaused

public void setBatchPaused(int batch_id,
                           boolean paused)

Set batch paused state.

Parameters:

batch_id - Batch id.

paused - Paused state.

setBatchPriority

public void setBatchPriority(int batch_id,
                             int priority)

Set batch priority.

Parameters:

batch_id - Batch id.

priority - Batch priority (2 - Highest, 1 - High, 0 - Normal, -1 - Low, -2 - Lowest).

setBatchWorkerLimit

public void setBatchWorkerLimit(int batch_id,
                                int worker_limit)

Set worker limit of the batch.

Parameters:

batch_id - Batch id.

worker_limit - Worker limit of the batch (0 - unlimited).

abortWorker

public void abortWorker(int worker_id)

Abort worker.

Parameters:

worker_id - Worker id.

quitWorker

public void quitWorker(int worker_id)

Quit worker.

Parameters:

worker_id - Worker id.

setWorkerPaused

public void setWorkerPaused(int worker_id,
                            boolean paused)

Set worker paused state.

Parameters:

worker_id - Worker id.

paused - Paused state.

setWorkerPriority

public void setWorkerPriority(int worker_id,
                              int priority)

Set worker priority.

Parameters:

worker_id - Worker id.

priority - Worker priority (2 - Highest, 1 - High, 0 - Normal, -1 - Low, -2 - Lowest).

setWorkerCapability

public void setWorkerCapability(int worker_id,
                                int capability)

Set worker capability.

Parameters:

worker_id - Worker id.

capability - Worker capability (1 - CPU, 2 - GPU, 3 - Any).

setWorkerGpuMask

public void setWorkerGpuMask(int worker_id,
                             long gpu_mask)

Set worker GPU mask.

Parameters:

worker_id - Worker id.

gpu_mask - GPU device mask.

setWorkerCpuEnabled

public void setWorkerCpuEnabled(int worker_id,
                                boolean cpu_enabled)

Set worker CPU enabled flag.

Parameters:

worker_id - Worker id.

cpu_enabled - CPU enabled flag.

getServerVersion

public NetworkClient.ServerVersion getServerVersion()

Get server version.

getServerInfo

public NetworkClient.ServerInfo getServerInfo(long revision)

Get server information.

Parameters:

revision - First revision to get.

Returns:

Server information.

setMasterServer

public void setMasterServer(java.lang.String hostname)

Set master server.

getBatchInfo

public NetworkClient.BatchInfo getBatchInfo(int batch_id,
                                            long revision)

Get batch information.

Parameters:

batch_id - Batch id.

revision - First revision to get.

Returns:

Batch information.

getWorkerInfo

public NetworkClient.WorkerInfo getWorkerInfo(int worker_id,
                                              long revision)

Get worker information.

Parameters:

worker_id - Worker id.

revision - First revision to get.

Returns:

Worker information.

getBatchList

public NetworkClient.BatchList getBatchList(long revision)

Get list of batches.

Parameters:

revision - First revision to get.

Returns:

List of batches.

getWorkerList

public NetworkClient.WorkerList getWorkerList(long revision)

Get list of workers.

Parameters:

revision: - First revision to get.

Returns:

List of workers.

exportBatches

public java.lang.String exportBatches(int[] batch_ids)

Export current state of batches.

Parameters:

batch_ids - Batch ids to export.

Returns:

Batches data.

importBatches

public void importBatches(java.lang.String data)

Import batches from exported data.

Parameters:

data - Batches data.