com.kuka.roboticsAPI.concurrencyModel
Interface ISyncManager

All Superinterfaces:

IEngine

All Known Implementing Classes:

SyncManager

public interface ISyncManager
extends IEngine

The SyncManager interface.

This element is not in its final state and might change in future versions.

Method Summary

CriticalArea	getCriticalArea(String name) Gets the critical area identified by the given name.
SyncHandle	getSyncHandle(String name) Gets a sync handle with the specified name.
SyncHandle	initSyncHandle(String syncHandleName, int count) Initializes a sync handle.
void	removeCriticalArea(String name) Removes the critical area with the given name.
void	removeSyncHandle(String syncHandleName) Removes the sync handle with the given name.

Methods inherited from interface com.kuka.roboticsAPI.IEngine

dispose, getContext, getEngineType, initialize, setParameters

Method Detail

removeCriticalArea

void removeCriticalArea(String name)

Removes the critical area with the given name. Be careful: Removing the area will not free any threads waiting for enter that area. You have to do that on your own.

Parameters:

name - The name of the critical area.

getCriticalArea

CriticalArea getCriticalArea(String name)

Gets the critical area identified by the given name.

Parameters:

name - The name of the critical area.

Returns:

The critical area object.

removeSyncHandle

void removeSyncHandle(String syncHandleName)

Removes the sync handle with the given name. Be careful: Removing the sync handle will not free any threads waiting on that handle. You have to do that on your own.

Parameters:

syncHandleName - The name of the sync handle.

getSyncHandle

SyncHandle getSyncHandle(String name)

Gets a sync handle with the specified name.

Parameters:

name - name of a handle.

Returns:

a sync handle with the specified name or null.

initSyncHandle

SyncHandle initSyncHandle(String syncHandleName,
                          int count)

Initializes a sync handle. If there is no sync handle with this name yet - creates it.

Parameters:

syncHandleName - name for the new handle.

count - number of threads that the new handle can block.

Returns:

a initialized SyncHandle object with this name.