com.vmware.vapi.server

Interface ServerInterface

All Superinterfaces:

Runnable

All Known Implementing Classes:

Server

public interface ServerInterface
extends Runnable

Interface for an ApiProvider server.

Method Summary

Methods

Modifier and Type	Method and Description
ProtocolConnection	getLocalConnection() Returns local connection to the primary API provider.
void	run() Runs the server.
void	stop() Stops the server.
boolean	waitForShutdown(long timeoutMillis) Wait for the server shutdown to complete.

Method Detail

stop

void stop()

Stops the server.

waitForShutdown

boolean waitForShutdown(long timeoutMillis)
                        throws InterruptedException

Wait for the server shutdown to complete. If the server is already shutdown, the method will return true immediately.

Parameters:

timeoutMillis - maximum time to wait for the shutdown to complete (in milliseconds)

Returns:

whether the shutdown completed or the timeout expired

Throws:

InterruptedException - the wait has been interrupted

run

void run()

Runs the server.

Specified by:

run in interface Runnable

getLocalConnection

ProtocolConnection getLocalConnection()

Returns local connection to the primary API provider. This connection can be used only by clients inside the same process.

Returns:

connection which involves no networking