public interface IInteropManager
Team repository objects are intended to be used by multi-threaded clients.
Unless noted, the methods on ITeamRepository
and its various
subsidiaries, including IInteropManager
, can be safely called
from multiple threads concurrently without risk of corruption.
| Modifier and Type | Method and Description |
|---|---|
void |
deleteSyncRule(ISyncRuleHandle syncRuleHandle,
org.eclipse.core.runtime.IProgressMonitor monitor)
Delete a synchronization rule from the repository.
|
IExternalState |
findExternalStatebyUri(java.net.URI uri,
org.eclipse.core.runtime.IProgressMonitor monitor)
Retrieve any external state for a proxy identified by an external
URI.
|
IExternalProxyHandle[] |
findProxiesBySyncRule(ISyncRuleHandle syncRuleHandle,
org.eclipse.core.runtime.IProgressMonitor monitor)
Retrieve any proxies that reference a particular synchronization rule
(or no synchronization rule at all).
|
IExternalProxy |
findProxybyTargetItem(IItemHandle targetItem,
org.eclipse.core.runtime.IProgressMonitor monitor)
Retrieve any proxy for an external object that is being synchronized
with a Jazz item, if any.
|
IExternalProxy |
findProxybyUri(java.net.URI uri,
org.eclipse.core.runtime.IProgressMonitor monitor)
Retrieve any proxy that may be replicating an external object.
|
ISyncRule |
findSyncRule(java.lang.String name,
org.eclipse.core.runtime.IProgressMonitor monitor)
Find a synchronization rule, given its name.
|
ISyncRuleHandle[] |
findSyncRulesByExternalTypeName(java.lang.String typeName,
org.eclipse.core.runtime.IProgressMonitor monitor)
Find any synchronization rules that are for a given external type.
|
ISyncRuleHandle[] |
findSyncRulesByExternalTypeNameAndProjectArea(java.lang.String typeName,
IProjectAreaHandle projectAreaHandle,
org.eclipse.core.runtime.IProgressMonitor monitor)
Find all synchronization rules for a given external type and associated
with a project area, or no project area.
|
ISyncRuleHandle[] |
findSyncRulesByProjectArea(IProjectAreaHandle projectAreaHandle,
org.eclipse.core.runtime.IProgressMonitor monitor)
Find synchronization rules associated with a project area.
|
ISyncRuleHandle[] |
getAllSyncRules(org.eclipse.core.runtime.IProgressMonitor monitor)
Get all of the sync rules (as handles) stored in the repository.
|
IExternalProxyHandle[] |
getBlockingProxies(IExternalProxyHandle proxyHandle,
boolean incoming,
org.eclipse.core.runtime.IProgressMonitor monitor)
Get any proxies that are blocking synchronization of a given proxy,
in the specified direction.
|
IExternalState |
getExternalState(IExternalProxy proxy,
org.eclipse.core.runtime.IProgressMonitor monitor)
Get the replicated state associated with a proxy.
|
java.sql.Timestamp |
getLastSearchTime(ISyncRule syncRule,
org.eclipse.core.runtime.IProgressMonitor monitor)
Get the time of the most recent scan for outgoing changes that was done
for the given synchronization rule, if any.
|
java.util.Map<java.lang.String,java.lang.Object> |
getLastSyncedInExternalState(IExternalProxy proxy,
org.eclipse.core.runtime.IProgressMonitor monitor)
Get the last replicated state associated with a proxy that was
synchronized into a Jazz item.
|
java.util.Map<java.lang.String,java.lang.Object> |
getLastSyncedOutExternalState(IExternalProxy proxy,
org.eclipse.core.runtime.IProgressMonitor monitor)
Get the last replicated state associated with a proxy that a Jazz item
was synchronized into.
|
java.util.Map<java.lang.String,java.lang.Object> |
getLatestState(IExternalProxy proxy,
org.eclipse.core.runtime.IProgressMonitor monitor)
Get the latest replicated state associated with a proxy.
|
IItemHandle |
getTargetItem(IExternalProxyHandle proxy,
org.eclipse.core.runtime.IProgressMonitor monitor)
Get the handle of any Jazz item that is being synchronized with an
external object, given the proxy for the external object.
|
java.util.Map<java.lang.String,java.lang.Object> |
getTargetItemState(IExternalProxyHandle proxyHandle,
org.eclipse.core.runtime.IProgressMonitor monitor)
Get the properties of a Jazz item that is being synchronized with an
external object, given the proxy for the external object.
|
java.net.URI |
getUri(IExternalProxyHandle proxy,
org.eclipse.core.runtime.IProgressMonitor monitor)
Get the URI for an external object that is represented by a
proxy.
|
boolean |
isSynchronizationEnabled(ISyncRule syncRule,
org.eclipse.core.runtime.IProgressMonitor monitor)
Determine whether synchronization is enabled for a particular
synchronization rule.
|
void |
resetLastSearchTime(ISyncRule syncRule,
boolean asAllModified,
org.eclipse.core.runtime.IProgressMonitor monitor)
Clear the time of the most recent scan for outgoing changes that was done
for the given synchronization rule.
|
IExternalState |
saveExternalState(IExternalState stateWorkingCopy,
org.eclipse.core.runtime.IProgressMonitor monitor)
Update the replicated state for an external object in the repository.
|
IExternalProxy |
saveProxy(IExternalProxy proxyWorkingCopy,
org.eclipse.core.runtime.IProgressMonitor monitor)
Update the given proxy in the repository.
|
IExternalProxy |
saveProxyWithState(IExternalProxy proxyWorkingCopy,
IExternalState stateWorkingCopy,
org.eclipse.core.runtime.IProgressMonitor monitor)
Update both a proxy and the replicated external state for an external
object in the repository.
|
IExternalProxy |
saveProxyWithStateAndUri(IExternalProxy proxyWorkingCopy,
IExternalState stateWorkingCopy,
java.net.URI uri,
org.eclipse.core.runtime.IProgressMonitor monitor)
Create or update the given proxy in the repository, along with the
replicated state of an external object.
|
IExternalProxy |
saveProxyWithTargetItem(IExternalProxy proxy,
IItemHandle targetItemHandle,
org.eclipse.core.runtime.IProgressMonitor monitor)
Save a new or updated proxy for an external object that is to be linked
to a Jazz item.
|
IExternalProxy |
saveProxyWithUri(IExternalProxy proxy,
java.net.URI uri,
org.eclipse.core.runtime.IProgressMonitor monitor)
Create or update the given proxy in the repository.
|
ISyncRule |
saveSyncRule(ISyncRule syncRuleWorkingCopy,
org.eclipse.core.runtime.IProgressMonitor monitor)
Save a new or updated synchronization rule to the repository.
|
void |
setOutgoingSyncJobState(boolean enabled)
Enable or disable the outgoing sync job.
|
void |
setSynchronizationEnabled(ISyncRule syncRule,
boolean enabled,
org.eclipse.core.runtime.IProgressMonitor monitor)
Set whether synchronization is enabled for a synchronization rule.
|
void |
setSynchronizeAllNewContributors(boolean enabled)
Enable or disable the whether or not all contributors are synced out, or just ones associated
with other synced objects.
|
void |
synchronizeDeletion(IExternalProxyHandle proxyHandle,
org.eclipse.core.runtime.IProgressMonitor monitor)
Schedule synchronization of the deletion of a proxy for an external
object.
|
void |
synchronizeDeletionAndWait(IExternalProxyHandle proxyHandle,
org.eclipse.core.runtime.IProgressMonitor monitor)
Schedule synchronization of the deletion of a proxy for an external
object, and wait for the request to be processed.
|
void |
synchronizeIncoming(IExternalProxyHandle proxyHandle,
IExternalStateHandle xstateHandle,
IAuditableHandle syncedItemStateHandle,
ISyncRuleHandle syncRuleHandle,
org.eclipse.core.runtime.IProgressMonitor monitor)
Schedule synchronization of a Jazz item with the state of an external
object.
|
IExternalProxy |
synchronizeIncomingAndWait(IExternalProxyHandle proxyHandle,
IExternalStateHandle xstateHandle,
IAuditableHandle syncedItemStateHandle,
ISyncRuleHandle syncRuleHandle,
org.eclipse.core.runtime.IProgressMonitor monitor)
Schedule synchronization of a Jazz item with the state of an external
object, and wait for the request to complete.
|
void |
synchronizeOutgoing(IItemHandle itemHandle,
IExternalStateHandle syncedXstateHandle,
ISyncRuleHandle syncRuleHandle,
org.eclipse.core.runtime.IProgressMonitor monitor)
Schedule synchronization of an external object associated with a Jazz
item, if there is one.
|
IExternalProxy |
synchronizeOutgoingAndWait(IItemHandle itemHandle,
IExternalStateHandle syncedXstateHandle,
ISyncRuleHandle syncRuleHandle,
org.eclipse.core.runtime.IProgressMonitor monitor)
Schedule synchronization of an external object associated with a Jazz
item, if there is one, and wait for the request to complete.
|
ITeamRepository |
teamRepository()
Returns the repository associated with this manager.
|
ITeamRepository teamRepository()
null
ITeamRepository.itemManager()
IExternalProxy saveProxy(IExternalProxy proxyWorkingCopy, org.eclipse.core.runtime.IProgressMonitor monitor) throws TeamRepositoryException
Note that this method cannot be used to update the replicated external
state associated with the proxy; it can only be used to update other
intrinsic properties of the proxy itself (e.g. the synchronization rule
to use). To both update a proxy's intrinsic properties and set new
replicated state from an external object (optionally triggering
incoming synchronization), use
#saveProxy(IExternalProxy, Map, boolean, IProgressMonitor)
.
To just update a proxy's replicated state and trigger synchronization,
use
#synchronizeIncoming(IExternalProxy, ISyncRule, IProgressMonitor)
Updating an existing item fails by throwing ItemNotFoundException
if the item being updated does not exist.
The operation fails by throwing StaleDataException
if the working
copy is not based on the current state of the item in the repository at
the time the server processes the save request. A client wishing to
handle this mid-air collision should (1) re-fetch the current state of
the item, (2) create a new working copy from it, (3) copy over changes
from the old working copy, and (4) save the new working copy.
This operation generates a shared item event.
proxyWorkingCopy
- a working copy describing the new or updated proxy;
must not be null
monitor
- a progress monitor, or null
if progress
reporting is not desirednull
NotLoggedInException
- if the operation fails because the client was not logged in
to the repositoryItemNotFoundException
- if the item was not foundTeamRepositoryException
- if the operation fails for any other reasonorg.eclipse.core.runtime.OperationCanceledException
- if the operation is canceled. Cancelation can occur even if
no progress monitor is provided.IExternalProxy saveProxyWithTargetItem(IExternalProxy proxy, IItemHandle targetItemHandle, org.eclipse.core.runtime.IProgressMonitor monitor) throws TeamRepositoryException
A proxy must always be associated with an external object (identified
by a URI) and/or a Jazz item. If the targetItemHandle
argument is non-null, then either the proxy must not already exist, or
it must already be associated with the same item. Once created, such an
association cannot be changed.
Updating an existing item fails by throwing ItemNotFoundException
if the item being updated does not exist.
The operation fails by throwing StaleDataException
if the working
copy is not based on the current state of the item in the repository at
the time the server processes the save request. A client wishing to
handle this mid-air collision should (1) re-fetch the current state of
the item, (2) create a new working copy from it, (3) copy over changes
from the old working copy, and (4) save the new working copy.
This operation generates a shared item event.
proxy
- the proxy for the external object; either a new item or
a working copy; never null
targetItemHandle
- the handle of the associated Jazz item, or null
if
existing proxy is already linked to an itemmonitor
- a progress monitor, or null
if progress
reporting is not desirednull
NotLoggedInException
- if the operation fails because the client was not logged in
to the repositoryTeamRepositoryException
- if the operation fails for any other reasonorg.eclipse.core.runtime.OperationCanceledException
- if the operation is canceled. Cancelation can occur even if
no progress monitor is provided.IExternalProxy saveProxyWithUri(IExternalProxy proxy, java.net.URI uri, org.eclipse.core.runtime.IProgressMonitor monitor) throws TeamRepositoryException
A proxy must always be associated with some external object (identified
by a URI) and/or a Jazz item. If the uri
argument is
non-null, then either the proxy must not already exist, or it must
already be associated with the same external object. Once created, such
an association cannot be changed.
Updating an existing item fails by throwing ItemNotFoundException
if the item being updated does not exist.
The operation fails by throwing StaleDataException
if the working
copy is not based on the current state of the item in the repository at
the time the server processes the save request. A client wishing to
handle this mid-air collision should (1) re-fetch the current state of
the item, (2) create a new working copy from it, (3) copy over changes
from the old working copy, and (4) save the new working copy.
This operation generates a shared item event.
proxy
- a new item or working copy describing the new or updated proxy;
must not be null
uri
- the URI of the external object, or null
if
existing proxy is already linked to an external objectmonitor
- a progress monitor, or null
if progress
reporting is not desirednull
NotLoggedInException
- if the operation fails because the client was not logged in
to the repositoryTeamRepositoryException
- if the operation fails for any other reasonorg.eclipse.core.runtime.OperationCanceledException
- if the operation is canceled. Cancelation can occur even if
no progress monitor is provided.IExternalProxy saveProxyWithState(IExternalProxy proxyWorkingCopy, IExternalState stateWorkingCopy, org.eclipse.core.runtime.IProgressMonitor monitor) throws TeamRepositoryException
The replicated state consists of a set of properties (i.e. name/value pairs), where both names and values are Strings.
To update a proxy without changing its replicated state or triggering
synchronization, use
saveProxy(IExternalProxy, IProgressMonitor)
.
To update replicated state and trigger synchronization without
otherwise modifying a proxy, use
saveExternalState(IExternalState, IProgressMonitor)
Note that this method first saves the proxy itself to the repository, along with the replicated state and any other properties of the proxy that have been modified. The proxy object that is returned represents the state of the proxy after it has been saved, but before any synchronization occurs. The returned object is a complete, shared item.
The operation fails by throwing StaleDataException
if the working
copy is not based on the current state of the item in the repository at
the time the server processes the save request. A client wishing to
handle this mid-air collision should (1) re-fetch the current state of
the item, (2) create a new working copy from it, (3) copy over changes
from the old working copy, and (4) save the new working copy.
This operation generates a shared item event.
proxyWorkingCopy
- a working copy of an existing item; must not be null
stateWorkingCopy
- a new item or a working copy; must not be null
monitor
- a progress monitor, or null
if progress
reporting is not desirednull
NotLoggedInException
- if the operation fails because the client was not logged in
to the repositoryItemNotFoundException
- if the item was not foundTeamRepositoryException
- if the operation fails for any other reasonorg.eclipse.core.runtime.OperationCanceledException
- if the operation is canceled. Cancelation can occur even if
no progress monitor is provided.IExternalProxy saveProxyWithStateAndUri(IExternalProxy proxyWorkingCopy, IExternalState stateWorkingCopy, java.net.URI uri, org.eclipse.core.runtime.IProgressMonitor monitor) throws TeamRepositoryException
A proxy must always be associated with some external object (identified
by a URI). If the uri
argument is non-null, then either the
proxy must not already exist, or it must already be associated with the
same external object. Once created, such an association cannot be changed.
The replicated state consists of a set of properties (i.e. name/value pairs), where both names and values are Strings.
To update a proxy without changing its replicated state or triggering
synchronization, use
saveProxy(IExternalProxy, IProgressMonitor)
.
To update replicated state and trigger synchronization without
otherwise modifying a proxy, use
saveExternalState(IExternalState, IProgressMonitor)
Note that this method first saves the proxy itself to the repository, along with the replicated state and any other properties of the proxy that have been modified. The proxy object that is returned represents the state of the proxy after it has been saved, but before any synchronization occurs. The returned object is a complete, shared item.
Updating an existing item fails by throwing ItemNotFoundException
if the item being updated does not exist.
The operation fails by throwing StaleDataException
if the working
copy is not based on the current state of the item in the repository at
the time the server processes the save request. A client wishing to
handle this mid-air collision should (1) re-fetch the current state of
the item, (2) create a new working copy from it, (3) copy over changes
from the old working copy, and (4) save the new working copy.
This operation generates a shared item event.
proxyWorkingCopy
- a new item or working copy; must not be null
stateWorkingCopy
- a new item or a working copy; must not be null
uri
- the URI of the external object, or null
if
existing proxy is already linked to an external objectmonitor
- a progress monitor, or null
if progress
reporting is not desirednull
NotLoggedInException
- if the operation fails because the client was not logged in
to the repositoryTeamRepositoryException
- if the operation fails for any other reasonorg.eclipse.core.runtime.OperationCanceledException
- if the operation is canceled. Cancelation can occur even if
no progress monitor is provided.IExternalProxy findProxybyTargetItem(IItemHandle targetItem, org.eclipse.core.runtime.IProgressMonitor monitor) throws TeamRepositoryException
If the proxy is found, this operation adds the proxy to the item manager and returns its shared item.
This operation generates a shared item event.
targetItem
- the target item of the proxy; never null
monitor
- a progress monitor, or null
if progress
reporting is not desirednull
if noneNotLoggedInException
- if the operation fails because the client was not logged in
to the repositoryTeamRepositoryException
- if anything else goes wrongorg.eclipse.core.runtime.OperationCanceledException
- if the operation is canceled. Cancelation can occur even if
no progress monitor is provided.IExternalProxy findProxybyUri(java.net.URI uri, org.eclipse.core.runtime.IProgressMonitor monitor) throws TeamRepositoryException
If the proxy is found, this operation adds the proxy to the item manager and returns its shared item.
This operation generates a shared item event.
uri
- the external object URI; never null
monitor
- a progress monitor, or null
if progress
reporting is not desirednull
if
noneNotLoggedInException
- if the operation fails because the client was not logged in
to the repositoryTeamRepositoryException
- if anything else goes wrongorg.eclipse.core.runtime.OperationCanceledException
- if the operation is canceled. Cancelation can occur even if
no progress monitor is provided.IExternalProxyHandle[] findProxiesBySyncRule(ISyncRuleHandle syncRuleHandle, org.eclipse.core.runtime.IProgressMonitor monitor) throws TeamRepositoryException
syncRuleHandle
- handle for the synchronization rule being referenced, or
null
to find proxies that reference no synchronization
rule at allmonitor
- a progress monitor, or null
if progress
reporting is not desirednull
;
may be emptyNotLoggedInException
- if the operation fails because the client was not logged in
to the repositoryTeamRepositoryException
- if anything else goes wrongorg.eclipse.core.runtime.OperationCanceledException
- if the operation is canceled. Cancelation can occur even if
no progress monitor is provided.IExternalState findExternalStatebyUri(java.net.URI uri, org.eclipse.core.runtime.IProgressMonitor monitor) throws TeamRepositoryException
If the external state item is found, this operation adds the item to the item manager and returns its shared item.
This operation generates a shared item event.
uri
- the external object URI; never null
null
if noneNotLoggedInException
- if the operation fails because the client was not logged in
to the repositoryTeamRepositoryException
- if anything else goes wrongorg.eclipse.core.runtime.OperationCanceledException
- if the operation is canceled. Cancelation can occur even if
no progress monitor is provided.IExternalState getExternalState(IExternalProxy proxy, org.eclipse.core.runtime.IProgressMonitor monitor) throws TeamRepositoryException
Note that, if this proxy is being synchronized with a Jazz item, the returned state may not yet have been synchronized - it represents the latest state received from the external object.
If the external state item is found, this operation adds the item to the item manager and returns its shared item.
This operation generates a shared item event.
proxy
- the proxy for the external object; never null
monitor
- a progress monitor, or null
if progress
reporting is not desirednull
if there is no external state,
or if the proxy state was fetched partially and does not include the
external state propertyNotLoggedInException
- if the operation fails because the client was not logged in
to the repositoryTeamRepositoryException
- if there is an error getting the state from the repositoryorg.eclipse.core.runtime.OperationCanceledException
- if the operation is canceled. Cancelation can occur even if
no progress monitor is provided.java.util.Map<java.lang.String,java.lang.Object> getLastSyncedInExternalState(IExternalProxy proxy, org.eclipse.core.runtime.IProgressMonitor monitor) throws TeamRepositoryException
If the proxy has no associated replicated state, or it was never
synchronized in the incoming direction with a Jazz item, then
null
is returned.
Note that this method does not return an IExternalState object since,
in general, the last-synced-in external state may not be the latest
state, and so cannot be used as the basis of an update (i.e. a working
copy). For that, use
getExternalState(IExternalProxy, IProgressMonitor)
instead.
The replicated state is not cached in the proxy object, so it is inefficient to make repeated calls to this method. In particular, it would be bad to do something like this, since the entire state would be fetched with each call.
String val1 = (String) getLastSynchronizedState.get("name1"); String val2 = (String) getLastSynchronizedState.get("name2"); ...
proxy
- the proxy for the external object; never null
monitor
- a progress monitor, or null
if progress
reporting is not desirednull
if there is no replicated
state, or it was never synchronized, or if this proxy state was
fetched partially and does not include the replicated state propertyNotLoggedInException
- if the operation fails because the client was not logged in
to the repositoryTeamRepositoryException
- if there is an error getting the state from the repositoryorg.eclipse.core.runtime.OperationCanceledException
- if the operation is canceled. Cancelation can occur even if
no progress monitor is provided.java.util.Map<java.lang.String,java.lang.Object> getLastSyncedOutExternalState(IExternalProxy proxy, org.eclipse.core.runtime.IProgressMonitor monitor) throws TeamRepositoryException
If the proxy has no associated replicated state, or it was never
synchronized in the outgoing direction with a Jazz item, then
null
is returned.
Note that this method does not return an IExternalState object since,
in general, the last-synced-out external state may not be the latest
state, and so cannot be used as the basis of an update (i.e. a working
copy). For that, use
getExternalState(IExternalProxy, IProgressMonitor)
instead.
The replicated state is not cached in the proxy object, so it is inefficient to make repeated calls to this method. In particular, it would be bad to do something like this, since the entire state would be fetched with each call.
String val1 = (String) getLastSynchronizedState.get("name1"); String val2 = (String) getLastSynchronizedState.get("name2"); ...
proxy
- the proxy for the external object; never null
monitor
- a progress monitor, or null
if progress
reporting is not desirednull
if there is no replicated
state, or it was never synchronized, or if this proxy state was
fetched partially and does not include the replicated state propertyNotLoggedInException
- if the operation fails because the client was not logged in
to the repositoryTeamRepositoryException
- if there is an error getting the state from the repositoryorg.eclipse.core.runtime.OperationCanceledException
- if the operation is canceled. Cancelation can occur even if
no progress monitor is provided.java.util.Map<java.lang.String,java.lang.Object> getLatestState(IExternalProxy proxy, org.eclipse.core.runtime.IProgressMonitor monitor) throws TeamRepositoryException
getExternalState(proxy).getState()Note that, if this proxy is being synchronized with a Jazz item, the returned state may not yet have been synchronized - it represents the latest state received from the external object.
The replicated state is not cached in the proxy object, so it is inefficient to make repeated calls to this method. In particular, it would be bad to do something like this, since the entire state would be fetched with each call.
String val1 = (String) getLatestState.get("name1"); String val2 = (String) getLatestState.get("name2"); ...
proxy
- the proxy for the external object; never null
monitor
- a progress monitor, or null
if progress
reporting is not desirednull
if there is no replicated state, or if
this proxy state was fetched partially and does not include the
replicated state propertyNotLoggedInException
- if the operation fails because the client was not logged in
to the repositoryTeamRepositoryException
- if there is an error getting the state from the repositoryorg.eclipse.core.runtime.OperationCanceledException
- if the operation is canceled. Cancelation can occur even if
no progress monitor is provided.IExternalState saveExternalState(IExternalState stateWorkingCopy, org.eclipse.core.runtime.IProgressMonitor monitor) throws TeamRepositoryException
IExternalState.REPLICATED_STATE_PROPERTY
property has been set
to the new replicated state of an external object. Returns the complete,
shared item for the proxy. Subsequent changes must be made from a new
working copy obtained from the resulting shared item. The working copy
passed in is not affected, but cannot be reused.
Updating an existing item fails by throwing ItemNotFoundException
if the item being updated does not exist.
The operation fails by throwing StaleDataException
if the working
copy is not based on the current state of the item in the repository at
the time the server processes the save request. A client wishing to
handle this mid-air collision should (1) re-fetch the current state of
the item, (2) create a new working copy from it, (3) copy over changes
from the old working copy, and (4) save the new working copy.
This operation generates a shared item event.
stateWorkingCopy
- a working copy describing the new or updated replicated state;
must not be null
monitor
- a progress monitor, or null
if progress
reporting is not desirednull
NotLoggedInException
- if the operation fails because the client was not logged in
to the repositoryItemNotFoundException
- if the item was not foundTeamRepositoryException
- if the operation fails for any other reasonorg.eclipse.core.runtime.OperationCanceledException
- if the operation is canceled. Cancelation can occur even if
no progress monitor is provided.java.net.URI getUri(IExternalProxyHandle proxy, org.eclipse.core.runtime.IProgressMonitor monitor) throws TeamRepositoryException
proxy
- the proxy for the external object; never null
monitor
- a progress monitor, or null
if progress
reporting is not desirednull
NotLoggedInException
- if the operation fails because the client was not logged in
to the repositoryItemNotFoundException
- if there is no external object linkTeamRepositoryException
- if a sync rule for the external type already exists, or
anything else goes wrongorg.eclipse.core.runtime.OperationCanceledException
- if the operation is canceled. Cancelation can occur even if
no progress monitor is provided.IItemHandle getTargetItem(IExternalProxyHandle proxy, org.eclipse.core.runtime.IProgressMonitor monitor) throws TeamRepositoryException
proxy
- the proxy for the external object; never null
monitor
- a progress monitor, or null
if progress
reporting is not desirednull
if noneNotLoggedInException
- if the operation fails because the client was not logged in
to the repositoryTeamRepositoryException
- if a sync rule for the external type already exists, or
anything else goes wrongorg.eclipse.core.runtime.OperationCanceledException
- if the operation is canceled. Cancelation can occur even if
no progress monitor is provided.java.util.Map<java.lang.String,java.lang.Object> getTargetItemState(IExternalProxyHandle proxyHandle, org.eclipse.core.runtime.IProgressMonitor monitor) throws TeamRepositoryException
THIS METHOD IS TENTATIVE AND SHOULD NOT BE USED OUTSIDE THE INTEROP COMPONENT
proxyHandle
- the handle for the external proxymonitor
- a progress monitor, or null
if progress
reporting is not desirednull
if there is no target item
being synchronizedNotLoggedInException
- if the operation fails because the client was not logged in
to the repositoryTeamRepositoryException
- if there is an error getting the state from the repositoryIExternalProxyHandle[] getBlockingProxies(IExternalProxyHandle proxyHandle, boolean incoming, org.eclipse.core.runtime.IProgressMonitor monitor) throws TeamRepositoryException
proxyHandle
- handle for the proxy that may be blockedincoming
- if true
, return proxies blocking incoming synchronization;
if false
, return proxies blocking outgoing synchronizationmonitor
- a progress monitor, or null
if progress
reporting is not desirednull
NotLoggedInException
- if the operation fails because the client was not logged in
to the repositoryItemNotFoundException
- if handle refers to non-existent itemTeamRepositoryException
- if anything else goes wrongvoid deleteSyncRule(ISyncRuleHandle syncRuleHandle, org.eclipse.core.runtime.IProgressMonitor monitor) throws TeamRepositoryException
This operation generates a shared item event if the item manager knows about the item being deleted.
[Note: This operation should require repository admin permission. Revisit when the permission model is in place.]
syncRuleHandle
- the handle of a sync rule to deletemonitor
- a progress monitor, or null
if progress
reporting is not desiredNotLoggedInException
- if the operation fails because the client was not logged in
to the repositoryTeamRepositoryException
- if anything else goes wrongorg.eclipse.core.runtime.OperationCanceledException
- if the operation is canceled. Cancelation can occur even if
no progress monitor is provided.ISyncRule saveSyncRule(ISyncRule syncRuleWorkingCopy, org.eclipse.core.runtime.IProgressMonitor monitor) throws TeamRepositoryException
Returns the complete, shared item for the proxy. Subsequent changes must be made from a new working copy obtained from the resulting shared item. The sync rule object passed in is not affected, but cannot be reused.
Updating an existing item fails by throwing ItemNotFoundException
if the item being updated does not exist.
The operation fails by throwing StaleDataException
if the working
copy is not based on the current state of the item in the repository at
the time the server processes the save request. A client wishing to
handle this mid-air collision should (1) re-fetch the current state of
the item, (2) create a new working copy from it, (3) copy over changes
from the old working copy, and (4) save the new working copy.
This operation generates a shared item event.
syncRuleWorkingCopy
- a working copy describing the new or updated sync rule;
must not be null
monitor
- a progress monitor, or null
if progress
reporting is not desirednull
NotLoggedInException
- if the operation fails because the client was not logged in
to the repositoryItemNotFoundException
- if the item was not foundTeamRepositoryException
- if the operation fails for any other reasonorg.eclipse.core.runtime.OperationCanceledException
- if the operation is canceled. Cancelation can occur even if
no progress monitor is provided.ISyncRule findSyncRule(java.lang.String name, org.eclipse.core.runtime.IProgressMonitor monitor) throws TeamRepositoryException
If the sync rule is found, this operation adds the sync rule to the item manager and returns its shared item.
This operation generates a shared item event.
name
- the name of the sync rulemonitor
- a progress monitor, or null
if progress
reporting is not desirednull
if notNotLoggedInException
- if the operation fails because the client was not logged in
to the repositoryTeamRepositoryException
- if anything else goes wrongorg.eclipse.core.runtime.OperationCanceledException
- if the operation is canceled. Cancelation can occur even if
no progress monitor is provided.ISyncRuleHandle[] findSyncRulesByExternalTypeName(java.lang.String typeName, org.eclipse.core.runtime.IProgressMonitor monitor) throws TeamRepositoryException
typeName
- a pattern for the external type name to search for;
'%' will match any substring and '_' will match any characternull
NotLoggedInException
- if the operation fails because the client was not logged in
to the repositoryTeamRepositoryException
- if anything else goes wrongorg.eclipse.core.runtime.OperationCanceledException
- if the operation is canceled. Cancelation can occur even if
no progress monitor is provided.ISyncRuleHandle[] findSyncRulesByProjectArea(IProjectAreaHandle projectAreaHandle, org.eclipse.core.runtime.IProgressMonitor monitor) throws TeamRepositoryException
projectAreaHandle
- handle for the project area to query for, or null
to
find synchronization rules unassociated with any project areamonitor
- a progress monitor, or null
if progress
reporting is not desirednull
;
may be emptyNotLoggedInException
- if the operation fails because the client was not logged in
to the repositoryorg.eclipse.core.runtime.OperationCanceledException
- if the operation is canceled. Cancelation can occur even if
no progress monitor is provided.TeamRepositoryException
- if anything else goes wrongISyncRuleHandle[] findSyncRulesByExternalTypeNameAndProjectArea(java.lang.String typeName, IProjectAreaHandle projectAreaHandle, org.eclipse.core.runtime.IProgressMonitor monitor) throws TeamRepositoryException
typeName
- a pattern for the external type name to search for;
'%' will match any substring and '_' will match any characterprojectAreaHandle
- handle for the project area to query for, or null
to
find synchronization rules unassociated with any project areamonitor
- a progress monitor, or null
if progress
reporting is not desirednull
;
may be emptyNotLoggedInException
- if the operation fails because the client was not logged in
to the repositoryorg.eclipse.core.runtime.OperationCanceledException
- if the operation is canceled. Cancelation can occur even if
no progress monitor is provided.TeamRepositoryException
- if anything else goes wrongISyncRuleHandle[] getAllSyncRules(org.eclipse.core.runtime.IProgressMonitor monitor) throws TeamRepositoryException
monitor
- a progress monitor, or null
if progress
reporting is not desirednull
;
may be emptyNotLoggedInException
- if the operation fails because the client was not logged in
to the repositoryTeamRepositoryException
- if anything else goes wrongorg.eclipse.core.runtime.OperationCanceledException
- if the operation is canceled. Cancelation can occur even if
no progress monitor is provided.boolean isSynchronizationEnabled(ISyncRule syncRule, org.eclipse.core.runtime.IProgressMonitor monitor) throws TeamRepositoryException
syncRule
- the synchronization rule to checkmonitor
- a progress monitor, or null
if progress
reporting is not desiredtrue
if synchronization is enabled, false
if notNotLoggedInException
- if the operation fails because the client was not logged in
to the repositoryItemNotFoundException
- if synchronization rule does not exist in repositoryorg.eclipse.core.runtime.OperationCanceledException
- if the operation is canceled. Cancelation can occur even if
no progress monitor is provided.TeamRepositoryException
- if anything else goes wrongvoid setSynchronizationEnabled(ISyncRule syncRule, boolean enabled, org.eclipse.core.runtime.IProgressMonitor monitor) throws TeamRepositoryException
syncRule
- the synchronization rule to enable or disableenabled
- true
to enable synchronization, false
to disable itmonitor
- a progress monitor, or null
if progress
reporting is not desiredNotLoggedInException
- if the operation fails because the client was not logged in
to the repositoryItemNotFoundException
- if synchronization rule does not exist in repositoryorg.eclipse.core.runtime.OperationCanceledException
- if the operation is canceled. Cancelation can occur even if
no progress monitor is provided.TeamRepositoryException
- if anything else goes wrongjava.sql.Timestamp getLastSearchTime(ISyncRule syncRule, org.eclipse.core.runtime.IProgressMonitor monitor) throws TeamRepositoryException
syncRule
- the synchronization rule to get the last search time formonitor
- a progress monitor, or null
if progress
reporting is not desirednull
if one has never been doneNotLoggedInException
- if the operation fails because the client was not logged in
to the repositoryItemNotFoundException
- if synchronization rule does not exist in repositoryorg.eclipse.core.runtime.OperationCanceledException
- if the operation is canceled. Cancelation can occur even if
no progress monitor is provided.TeamRepositoryException
- if anything else goes wrongvoid resetLastSearchTime(ISyncRule syncRule, boolean asAllModified, org.eclipse.core.runtime.IProgressMonitor monitor) throws TeamRepositoryException
The time can be cleared in two ways: as if outgoing synchronization has never been run, in which case the next scan will consider all items covered by the synchronization rule that have been modified since the synchronization rule was last modified, or as if the last scan occurred before the existence of any item, so that all existing items covered by the synchronization rule are considered.
syncRule
- the synchronization rule to reset the last search time forasAllModified
- if false
, next scan will consider only items modified
after the sync rule; if true
, next scan will consider
all existing items covered by the sync rulemonitor
- a progress monitor, or null
if progress
reporting is not desiredNotLoggedInException
- if the operation fails because the client was not logged in
to the repositoryItemNotFoundException
- if synchronization rule does not exist in repositoryorg.eclipse.core.runtime.OperationCanceledException
- if the operation is canceled. Cancelation can occur even if
no progress monitor is provided.TeamRepositoryException
- if anything else goes wrongvoid synchronizeIncoming(IExternalProxyHandle proxyHandle, IExternalStateHandle xstateHandle, IAuditableHandle syncedItemStateHandle, ISyncRuleHandle syncRuleHandle, org.eclipse.core.runtime.IProgressMonitor monitor) throws TeamRepositoryException
If the xstateHandle
argument is not null
, then
it must be a state handle (not just an item handle), and synchronization
will be done with respect to the particular state supplied. Otherwise,
synchronization will be done with respect to the latest external state
associated with the proxy at the time the request is processed.
The synchronization request is put at the end of a queue of any other pending requests for the same proxy object, and this method returns immediately.
Note that if no incoming synchronization is configured (either because there is no sync rule, or it does not specify incoming synchronization), then this method does nothing.
Normally, synchronization is scheduled every time the replicated state for an external object is updated. This method can be used to explicitly request synchronization (for example, to retry synchronization after it failed).
proxyHandle
- the handle for the proxy; never null
xstateHandle
- the handle for the new external state, or null
to use the latest state associated with the proxysyncedItemStateHandle
- handle of the Jazz item state that is known to have been
synchronized with the external object (i.e. after a manual merge),
or null
if the external object was independently
modifiedsyncRuleHandle
- handle for the synchronization rule for the
combination of external object type and Jazz item type, or
null
to use the synchronization rule already associated
with the proxymonitor
- a progress monitor, or null
if progress
reporting is not desiredNotLoggedInException
- if the operation fails because the client was not logged in
to the repositoryTeamRepositoryException
- if anything else goes wrongorg.eclipse.core.runtime.OperationCanceledException
- if the operation is canceled. Cancelation can occur even if
no progress monitor is provided.IExternalProxy synchronizeIncomingAndWait(IExternalProxyHandle proxyHandle, IExternalStateHandle xstateHandle, IAuditableHandle syncedItemStateHandle, ISyncRuleHandle syncRuleHandle, org.eclipse.core.runtime.IProgressMonitor monitor) throws TeamRepositoryException
If the request completes normally, the full state of the proxy object
resulting from processing the request is returned. If the request did
not complete normally (meaning that it was aborted or cancelled, not that
there was a synchronization error), then null
is returned.
This operation adds the proxy to the item manager and returns its shared item.
This operation generates a shared item event.
See #synchronizeIncoming(IExternalProxyHandle, IExternalStateHandle, ISyncRuleHandle)
for details on how the request is processed.
proxyHandle
- the handle of the proxy for the external object; never
null
xstateHandle
- the handle for the new external state, or null
to use the latest state associated with the proxysyncedItemStateHandle
- handle of the Jazz item state that is known to have been
synchronized with the external object (i.e. after a manual merge),
or null
if the external object was independently
modifiedsyncRuleHandle
- the handle for the synchronization rule for the
combination of external object type and Jazz item type, or
null
to use the synchronization rule already associated
with the proxymonitor
- a progress monitor, or null
if progress
reporting is not desirednull
if the request was
terminated earlyNotLoggedInException
- if the operation fails because the client was not logged in
to the repositoryTeamRepositoryException
- if anything else goes wrongorg.eclipse.core.runtime.OperationCanceledException
- if the operation is canceled. Cancelation can occur even if
no progress monitor is provided.void synchronizeOutgoing(IItemHandle itemHandle, IExternalStateHandle syncedXstateHandle, ISyncRuleHandle syncRuleHandle, org.eclipse.core.runtime.IProgressMonitor monitor) throws TeamRepositoryException
The synchronization request is put at the end of a queue of any other pending requests for the same proxy object, and this method returns immediately.
itemHandle
- handle to a Jazz item that may be associated with an external objectsyncedXstateHandle
- handle of the external state that the Jazz item is
known to have been synchronized with (i.e. after a manual merge), or
null
if the item was independently modifiedsyncRuleHandle
- handle for the synchronization rule for the
combination of external object type and Jazz item type, or
null
to use the synchronization rule already associated
with the proxymonitor
- a progress monitor, or null
if progress
reporting is not desiredNotLoggedInException
- if the operation fails because the client was not logged in
to the repositoryItemNotFoundException
- if no sync rule supplied and none
associated with the proxyTeamRepositoryException
- if anything else goes wrongorg.eclipse.core.runtime.OperationCanceledException
- if the operation is canceled. Cancelation can occur even if
no progress monitor is provided.IExternalProxy synchronizeOutgoingAndWait(IItemHandle itemHandle, IExternalStateHandle syncedXstateHandle, ISyncRuleHandle syncRuleHandle, org.eclipse.core.runtime.IProgressMonitor monitor) throws TeamRepositoryException
If the request completes normally, the full state of the proxy object
resulting from processing the request is returned. If the request did
not complete normally (meaning that it was aborted or cancelled, not that
there was a synchronization error), then null
is returned.
If a proxy is returned, this operation adds the proxy to the item manager and returns its shared item.
This operation generates a shared item event.
See #synchronizeOutgoing(IItemHandle, ISyncRuleHandle)
for
details on how the request is processed.
itemHandle
- handle to a Jazz item that may be associated with an external object;
if the item has history and the handle does not identify a state,
then the latest state of the item is usedsyncedXstateHandle
- handle of the external state that the Jazz item is
known to have been synchronized with (i.e. after a manual merge), or
null
if the item was independently modifiedsyncRuleHandle
- handle for the synchronization rule for the
combination of external object type and Jazz item type, or
null
to use the synchronization rule already associated
with the proxymonitor
- a progress monitor, or null
if progress
reporting is not desirednull
if the request was
terminated earlyNotLoggedInException
- if the operation fails because the client was not logged in
to the repositoryTeamRepositoryException
- if anything else goes wrongorg.eclipse.core.runtime.OperationCanceledException
- if the operation is canceled. Cancelation can occur even if
no progress monitor is provided.void synchronizeDeletion(IExternalProxyHandle proxyHandle, org.eclipse.core.runtime.IProgressMonitor monitor) throws TeamRepositoryException
The synchronization request is put at the end of a queue of any other pending requests for the same proxy object, and this method returns immediately.
Note that the item manager is not informed of any deleted items, because the deletion happens sometime later.
proxyHandle
- the handle of the proxy for the external object; never
null
monitor
- a progress monitor, or null
if progress
reporting is not desiredNotLoggedInException
- if the operation fails because the client was not logged in
to the repositoryTeamRepositoryException
- if anything else goes wrongorg.eclipse.core.runtime.OperationCanceledException
- if the operation is canceled. Cancelation can occur even if
no progress monitor is provided.void synchronizeDeletionAndWait(IExternalProxyHandle proxyHandle, org.eclipse.core.runtime.IProgressMonitor monitor) throws TeamRepositoryException
See #synchronizeDeletion(IExternalProxyHandle)
for details on how the request is processed.
This operation generates a shared item event if the item manager knows about the items being deleted.
proxyHandle
- the handle of the proxy for the external object; never
null
NotLoggedInException
- if the operation fails because the client was not logged in
to the repositoryTeamRepositoryException
- if anything else goes wrongorg.eclipse.core.runtime.OperationCanceledException
- if the operation is canceled. Cancelation can occur even if
no progress monitor is provided.void setOutgoingSyncJobState(boolean enabled)
enabled
- true
to enable the job, false
to disablevoid setSynchronizeAllNewContributors(boolean enabled)
enabled
- true
to enable the job, false
to disable


In this section we illustrate the use of some of the string functions by defining a function to split a line of text into individual words. We have already made use of this function in the concordance example program in Section 9.3.3.
NOTE -- The split function is in the concordance program in file concord.cpp.
There are three arguments to this function. The first two are strings, describing the line of text and the separators to be used to differentiate words, respectively. The third argument is a list of strings, used to return the individual words in the line.
void split (const std::string& text, const std::string& separators, std::list<std::string, std::allocator<std::string> >& words) { size_t n = text.length (); size_t start = text.find_first_not_of (separators); while (start < n) { size_t stop = text.find_first_of (separators, start); if (stop > n) stop = n; words.push_back (text.substr (start, stop-start)); start = text.find_first_not_of (separators, stop+1); } }
The program begins by finding start, the index of the first character that is not a separator. The loop then looks for stop, the index of the next character that is a separator, or uses the end of the string if no such value is found. These two indexes delimit a word, which is copied out of the text using a substring operation and inserted into the list of words. A search is then made to discover the start of the next word, and the loop continues. When the index value exceeds the limits of the string, execution stops.


# Async.js
[![Build Status via Travis CI](https://travis-ci.org/caolan/async.svg?branch=master)](https://travis-ci.org/caolan/async)
Async is a utility module which provides straight-forward, powerful functions for working with asynchronous JavaScript. Although originally designed for use with [Node.js](http://nodejs.org) and installable via npm install async, it can also be used directly in the browser.
Async is also installable via:
- [bower](http://bower.io/): bower install async
- [component](https://github.com/component/component): component install caolan/async
- [jam](http://jamjs.org/): jam install async
- [spm](http://spmjs.io/): spm install async
Async provides around 20 functions that include the usual ‘functional’ suspects (map, reduce, filter, each…) as well as some common patterns for asynchronous control flow (parallel, series, waterfall…). All these functions assume you follow the Node.js convention of providing a single callback as the last argument of your async function.
## Quick Examples
```javascript async.map([‘file1’,’file2’,’file3’], fs.stat, function(err, results){
// results is now an array of stats for each file
});
- async.filter([‘file1’,’file2’,’file3’], fs.exists, function(results){
- // results now equals an array of the existing files
});
- async.parallel([
- function(){ ... }, function(){ ... }
], callback);
- async.series([
- function(){ ... }, function(){ ... }
]);¶
There are many more functions available so take a look at the docs below for a full list. This module aims to be comprehensive, so if you feel anything is missing please create a GitHub issue for it.
## Common Pitfalls
### Binding a context to an iterator
This section is really about bind, not about async. If you are wondering how to make async execute your iterators in a given context, or are confused as to why a method of another library isn’t working as an iterator, study this example:
```js // Here is a simple object with an (unnecessarily roundabout) squaring method var AsyncSquaringLibrary = {
squareExponent: 2, square: function(number, callback){
var result = Math.pow(number, this.squareExponent); setTimeout(function(){
callback(null, result);}, 200);
}
};
- async.map([1, 2, 3], AsyncSquaringLibrary.square, function(err, result){
- // result is [NaN, NaN, NaN] // This fails because the this.squareExponent expression in the square // function is not evaluated in the context of AsyncSquaringLibrary, and is // therefore undefined.
});
- async.map([1, 2, 3], AsyncSquaringLibrary.square.bind(AsyncSquaringLibrary), function(err, result){
- // result is [1, 4, 9] // With the help of bind we can attach a context to the iterator before // passing it to async. Now the square function will be executed in its // ‘home’ AsyncSquaringLibrary context and the value of this.squareExponent // will be as expected.
});¶
## Download
The source is available for download from [GitHub](http://github.com/caolan/async). Alternatively, you can install using Node Package Manager (npm):
npm install async
__Development:__ [async.js](https://github.com/caolan/async/raw/master/lib/async.js) - 29.6kb Uncompressed
## In the Browser
So far it’s been tested in IE6, IE7, IE8, FF3.6 and Chrome 5.
Usage:
```html <script type=”text/javascript” src=”async.js”></script> <script type=”text/javascript”>
- async.map(data, asyncProcess, function(err, results){
- alert(results);
});
## Documentation
### Collections
- [each](#each)
- [eachSeries](#eachSeries)
- [eachLimit](#eachLimit)
- [map](#map)
- [mapSeries](#mapSeries)
- [mapLimit](#mapLimit)
- [filter](#filter)
- [filterSeries](#filterSeries)
- [reject](#reject)
- [rejectSeries](#rejectSeries)
- [reduce](#reduce)
- [reduceRight](#reduceRight)
- [detect](#detect)
- [detectSeries](#detectSeries)
- [sortBy](#sortBy)
- [some](#some)
- [every](#every)
- [concat](#concat)
- [concatSeries](#concatSeries)
### Control Flow
- [series](#seriestasks-callback)
- [parallel](#parallel)
- [parallelLimit](#parallellimittasks-limit-callback)
- [whilst](#whilst)
- [doWhilst](#doWhilst)
- [until](#until)
- [doUntil](#doUntil)
- [forever](#forever)
- [waterfall](#waterfall)
- [compose](#compose)
- [seq](#seq)
- [applyEach](#applyEach)
- [applyEachSeries](#applyEachSeries)
- [queue](#queue)
- [priorityQueue](#priorityQueue)
- [cargo](#cargo)
- [auto](#auto)
- [retry](#retry)
- [iterator](#iterator)
- [apply](#apply)
- [nextTick](#nextTick)
- [times](#times)
- [timesSeries](#timesSeries)
### Utils
- [memoize](#memoize)
- [unmemoize](#unmemoize)
- [log](#log)
- [dir](#dir)
- [noConflict](#noConflict)
## Collections
<a name=”forEach” /> <a name=”each” /> ### each(arr, iterator, callback)
Applies the function iterator to each item in arr, in parallel. The iterator is called with an item from the list, and a callback for when it has finished. If the iterator passes an error to its callback, the main callback (for the each function) is immediately called with the error.
Note, that since this function applies iterator to each item in parallel, there is no guarantee that the iterator functions will complete in order.
__Arguments__
- arr - An array to iterate over.
- iterator(item, callback) - A function to apply to each item in arr. The iterator is passed a callback(err) which must be called once it has completed. If no error has occurred, the callback should be run without arguments or with an explicit null argument.
- callback(err) - A callback which is called when all iterator functions have finished, or an error occurs.
__Examples__
```js // assuming openFiles is an array of file names and saveFile is a function // to save the modified contents of that file:
- async.each(openFiles, saveFile, function(err){
- // if any of the saves produced an error, err would equal that error
});¶
```js // assuming openFiles is an array of file names
async.each(openFiles, function(file, callback) {
// Perform operation on file here. console.log(‘Processing file ‘ + file);
- if( file.length > 32 ) {
- console.log(‘This file name is too long’); callback(‘File name too long’);
- } else {
- // Do work to process file here console.log(‘File processed’); callback();
}
- }, function(err){
// if any of the file processing produced an error, err would equal that error if( err ) {
// One of the iterations produced an error. // All processing will now stop. console.log(‘A file failed to process’);- } else {
- console.log(‘All files have been processed successfully’);
}
});¶
<a name=”forEachSeries” /> <a name=”eachSeries” /> ### eachSeries(arr, iterator, callback)
The same as [each](#each), only iterator is applied to each item in arr in series. The next iterator is only called once the current one has completed. This means the iterator functions will complete in order.
<a name=”forEachLimit” /> <a name=”eachLimit” /> ### eachLimit(arr, limit, iterator, callback)
The same as [each](#each), only no more than limit `iterator`s will be simultaneously running at any time.
Note that the items in arr are not processed in batches, so there is no guarantee that the first limit iterator functions will complete before any others are started.
__Arguments__
- arr - An array to iterate over.
- limit - The maximum number of `iterator`s to run at any time.
- iterator(item, callback) - A function to apply to each item in arr. The iterator is passed a callback(err) which must be called once it has completed. If no error has occurred, the callback should be run without arguments or with an explicit null argument.
- callback(err) - A callback which is called when all iterator functions have finished, or an error occurs.
__Example__
```js // Assume documents is an array of JSON objects and requestApi is a // function that interacts with a rate-limited REST api.
- async.eachLimit(documents, 20, requestApi, function(err){
- // if any of the saves produced an error, err would equal that error
});¶
 ### map(arr, iterator, callback)
Produces a new array of values by mapping each value in arr through the iterator function. The iterator is called with an item from arr and a callback for when it has finished processing. Each of these callback takes 2 arguments: an error, and the transformed item from arr. If iterator passes an error to his callback, the main callback (for the map function) is immediately called with the error.
Note, that since this function applies the iterator to each item in parallel, there is no guarantee that the iterator functions will complete in order. However, the results array will be in the same order as the original arr.
__Arguments__
- arr - An array to iterate over.
- iterator(item, callback) - A function to apply to each item in arr. The iterator is passed a callback(err, transformed) which must be called once it has completed with an error (which can be null) and a transformed item.
- callback(err, results) - A callback which is called when all iterator functions have finished, or an error occurs. Results is an array of the transformed items from the arr.
__Example__
```js async.map([‘file1’,’file2’,’file3’], fs.stat, function(err, results){
// results is now an array of stats for each file
});¶
<a name=”mapSeries” /> ### mapSeries(arr, iterator, callback)
The same as [map](#map), only the iterator is applied to each item in arr in series. The next iterator is only called once the current one has completed. The results array will be in the same order as the original.
<a name=”mapLimit” /> ### mapLimit(arr, limit, iterator, callback)
The same as [map](#map), only no more than limit `iterator`s will be simultaneously running at any time.
Note that the items are not processed in batches, so there is no guarantee that the first limit iterator functions will complete before any others are started.
__Arguments__
- arr - An array to iterate over.
- limit - The maximum number of `iterator`s to run at any time.
- iterator(item, callback) - A function to apply to each item in arr. The iterator is passed a callback(err, transformed) which must be called once it has completed with an error (which can be null) and a transformed item.
- callback(err, results) - A callback which is called when all iterator calls have finished, or an error occurs. The result is an array of the transformed items from the original arr.
__Example__
```js async.mapLimit([‘file1’,’file2’,’file3’], 1, fs.stat, function(err, results){
// results is now an array of stats for each file
});¶
  ### filter(arr, iterator, callback)
__Alias:__ select
Returns a new array of all the values in arr which pass an async truth test. _The callback for each iterator call only accepts a single argument of true or false; it does not accept an error argument first!_ This is in-line with the way node libraries work with truth tests like fs.exists. This operation is performed in parallel, but the results array will be in the same order as the original.
__Arguments__
- arr - An array to iterate over.
- iterator(item, callback) - A truth test to apply to each item in arr. The iterator is passed a callback(truthValue), which must be called with a boolean argument once it has completed.
- callback(results) - A callback which is called after all the iterator functions have finished.
__Example__
```js async.filter([‘file1’,’file2’,’file3’], fs.exists, function(results){
// results now equals an array of the existing files
});¶
<a name=”selectSeries” /> <a name=”filterSeries” /> ### filterSeries(arr, iterator, callback)
__Alias:__ selectSeries
The same as [filter](#filter) only the iterator is applied to each item in arr in series. The next iterator is only called once the current one has completed. The results array will be in the same order as the original.
<a name=”reject” /> ### reject(arr, iterator, callback)
The opposite of [filter](#filter). Removes values that pass an async truth test.
<a name=”rejectSeries” /> ### rejectSeries(arr, iterator, callback)
The same as [reject](#reject), only the iterator is applied to each item in arr in series.
<a name=”reduce” /> ### reduce(arr, memo, iterator, callback)
__Aliases:__ inject, foldl
Reduces arr into a single value using an async iterator to return each successive step. memo is the initial state of the reduction. This function only operates in series.
For performance reasons, it may make sense to split a call to this function into a parallel map, and then use the normal Array.prototype.reduce on the results. This function is for situations where each step in the reduction needs to be async; if you can get the data before reducing it, then it’s probably a good idea to do so.
__Arguments__
- arr - An array to iterate over.
- memo - The initial state of the reduction.
- iterator(memo, item, callback) - A function applied to each item in the array to produce the next step in the reduction. The iterator is passed a callback(err, reduction) which accepts an optional error as its first argument, and the state of the reduction as the second. If an error is passed to the callback, the reduction is stopped and the main callback is immediately called with the error.
- callback(err, result) - A callback which is called after all the iterator functions have finished. Result is the reduced value.
__Example__
```js async.reduce([1,2,3], 0, function(memo, item, callback){
// pointless async: process.nextTick(function(){
callback(null, memo + item)});
- }, function(err, result){
- // result is now equal to the last value of memo, which is 6
});¶
 ### reduceRight(arr, memo, iterator, callback)
__Alias:__ foldr
Same as [reduce](#reduce), only operates on arr in reverse order.
 ### detect(arr, iterator, callback)
Returns the first value in arr that passes an async truth test. The iterator is applied in parallel, meaning the first iterator to return true will fire the detect callback with that result. That means the result might not be the first item in the original arr (in terms of order) that passes the test.
If order within the original arr is important, then look at [detectSeries](#detectSeries).
__Arguments__
- arr - An array to iterate over.
- iterator(item, callback) - A truth test to apply to each item in arr. The iterator is passed a callback(truthValue) which must be called with a boolean argument once it has completed.
- callback(result) - A callback which is called as soon as any iterator returns true, or after all the iterator functions have finished. Result will be the first item in the array that passes the truth test (iterator) or the value undefined if none passed.
__Example__
```js async.detect([‘file1’,’file2’,’file3’], fs.exists, function(result){
// result now equals the first file in the list that exists
});¶
<a name=”detectSeries” /> ### detectSeries(arr, iterator, callback)
The same as [detect](#detect), only the iterator is applied to each item in arr in series. This means the result is always the first in the original arr (in terms of array order) that passes the truth test.
<a name=”sortBy” /> ### sortBy(arr, iterator, callback)
Sorts a list by the results of running each arr value through an async iterator.
__Arguments__
- arr - An array to iterate over.
- iterator(item, callback) - A function to apply to each item in arr. The iterator is passed a callback(err, sortValue) which must be called once it has completed with an error (which can be null) and a value to use as the sort criteria.
- callback(err, results) - A callback which is called after all the iterator functions have finished, or an error occurs. Results is the items from the original arr sorted by the values returned by the iterator calls.
__Example__
```js async.sortBy([‘file1’,’file2’,’file3’], function(file, callback){
- fs.stat(file, function(err, stats){
- callback(err, stats.mtime);
});
- }, function(err, results){
- // results is now the original array of files sorted by // modified date
});¶
__Sort Order__
By modifying the callback parameter the sorting order can be influenced:
```js //ascending order async.sortBy([1,9,3,5], function(x, callback){
callback(null, x);
- }, function(err,result){
- //result callback
} );
//descending order async.sortBy([1,9,3,5], function(x, callback){
callback(null, x*-1); //<- x*-1 instead of x, turns the order around
- }, function(err,result){
- //result callback
<a name=”some” /> ### some(arr, iterator, callback)
__Alias:__ any
Returns true if at least one element in the arr satisfies an async test. _The callback for each iterator call only accepts a single argument of true or false; it does not accept an error argument first!_ This is in-line with the way node libraries work with truth tests like fs.exists. Once any iterator call returns true, the main callback is immediately called.
__Arguments__
- arr - An array to iterate over.
- iterator(item, callback) - A truth test to apply to each item in the array in parallel. The iterator is passed a callback(truthValue) which must be called with a boolean argument once it has completed.
- callback(result) - A callback which is called as soon as any iterator returns true, or after all the iterator functions have finished. Result will be either true or false depending on the values of the async tests.
__Example__
```js async.some([‘file1’,’file2’,’file3’], fs.exists, function(result){
// if result is true then at least one of the files exists
});¶
 ### every(arr, iterator, callback)
__Alias:__ all
Returns true if every element in arr satisfies an async test. _The callback for each iterator call only accepts a single argument of true or false; it does not accept an error argument first!_ This is in-line with the way node libraries work with truth tests like fs.exists.
__Arguments__
- arr - An array to iterate over.
- iterator(item, callback) - A truth test to apply to each item in the array in parallel. The iterator is passed a callback(truthValue) which must be called with a boolean argument once it has completed.
- callback(result) - A callback which is called after all the iterator functions have finished. Result will be either true or false depending on the values of the async tests.
__Example__
```js async.every([‘file1’,’file2’,’file3’], fs.exists, function(result){
// if result is true then every file exists
});¶
<a name=”concat” /> ### concat(arr, iterator, callback)
Applies iterator to each item in arr, concatenating the results. Returns the concatenated list. The iterator`s are called in parallel, and the results are concatenated as they return. There is no guarantee that the results array will be returned in the original order of `arr passed to the iterator function.
__Arguments__
- arr - An array to iterate over.
- iterator(item, callback) - A function to apply to each item in arr. The iterator is passed a callback(err, results) which must be called once it has completed with an error (which can be null) and an array of results.
- callback(err, results) - A callback which is called after all the iterator functions have finished, or an error occurs. Results is an array containing the concatenated results of the iterator function.
__Example__
```js async.concat([‘dir1’,’dir2’,’dir3’], fs.readdir, function(err, files){
// files is now a list of filenames that exist in the 3 directories
});¶
 ### concatSeries(arr, iterator, callback)
Same as [concat](#concat), but executes in series instead of parallel.
## Control Flow
 ### series(tasks, [callback])
Run the functions in the tasks array in series, each one running once the previous function has completed. If any functions in the series pass an error to its callback, no more functions are run, and callback is immediately called with the value of the error. Otherwise, callback receives an array of results when tasks have completed.
It is also possible to use an object instead of an array. Each property will be run as a function, and the results will be passed to the final callback as an object instead of an array. This can be a more readable way of handling results from [series](#series).
Note that while many implementations preserve the order of object properties, the [ECMAScript Language Specifcation](http://www.ecma-international.org/ecma-262/5.1/#sec-8.6) explicitly states that
> The mechanics and order of enumerating the properties is not specified.
So if you rely on the order in which your series of functions are executed, and want this to work on all platforms, consider using an array.
__Arguments__
- tasks - An array or object containing functions to run, each function is passed a callback(err, result) it must call on completion with an error err (which can be null) and an optional result value.
- callback(err, results) - An optional callback to run once all the functions have completed. This function gets a results array (or object) containing all the result arguments passed to the task callbacks.
__Example__
- function(callback){
- // do some stuff ... callback(null, ‘one’);
}, function(callback){
// do some more stuff ... callback(null, ‘two’);}
], // optional callback function(err, results){
// results is now equal to [‘one’, ‘two’]
});
// an example using an object instead of an array async.series({
- one: function(callback){
- setTimeout(function(){
- callback(null, 1);
}, 200);
}, two: function(callback){
- setTimeout(function(){
- callback(null, 2);
}, 100);
}
}, function(err, results) {
// results is now equal to: {one: 1, two: 2}
});¶
 ### parallel(tasks, [callback])
Run the tasks array of functions in parallel, without waiting until the previous function has completed. If any of the functions pass an error to its callback, the main callback is immediately called with the value of the error. Once the tasks have completed, the results are passed to the final callback as an array.
It is also possible to use an object instead of an array. Each property will be run as a function and the results will be passed to the final callback as an object instead of an array. This can be a more readable way of handling results from [parallel](#parallel).
__Arguments__
- tasks - An array or object containing functions to run. Each function is passed a callback(err, result) which it must call on completion with an error err (which can be null) and an optional result value.
- callback(err, results) - An optional callback to run once all the functions have completed. This function gets a results array (or object) containing all the result arguments passed to the task callbacks.
__Example__
- function(callback){
- setTimeout(function(){
- callback(null, ‘one’);
}, 200);
}, function(callback){
- setTimeout(function(){
- callback(null, ‘two’);
}, 100);
}
], // optional callback function(err, results){
// the results array will equal [‘one’,’two’] even though // the second function had a shorter timeout.
});
// an example using an object instead of an array async.parallel({
- one: function(callback){
- setTimeout(function(){
- callback(null, 1);
}, 200);
}, two: function(callback){
- setTimeout(function(){
- callback(null, 2);
}, 100);
}
}, function(err, results) {
// results is now equals to: {one: 1, two: 2}
});¶
 ### parallelLimit(tasks, limit, [callback])
The same as [parallel](#parallel), only tasks are executed in parallel with a maximum of limit tasks executing at any time.
Note that the tasks are not executed in batches, so there is no guarantee that the first limit tasks will complete before any others are started.
__Arguments__
- tasks - An array or object containing functions to run, each function is passed a callback(err, result) it must call on completion with an error err (which can be null) and an optional result value.
- limit - The maximum number of tasks to run at any time.
- callback(err, results) - An optional callback to run once all the functions have completed. This function gets a results array (or object) containing all the result arguments passed to the task callbacks.
 ### whilst(test, fn, callback)
Repeatedly call fn, while test returns true. Calls callback when stopped, or an error occurs.
__Arguments__
- test() - synchronous truth test to perform before each execution of fn.
- fn(callback) - A function which is called each time test passes. The function is passed a callback(err), which must be called once it has completed with an optional err argument.
- callback(err) - A callback which is called after the test fails and repeated execution of fn has stopped.
__Example__
- async.whilst(
function () { return count < 5; }, function (callback) {
count++; setTimeout(callback, 1000);}, function (err) {
// 5 seconds have passed}
);¶
 ### doWhilst(fn, test, callback)
The post-check version of [whilst](#whilst). To reflect the difference in the order of operations, the arguments test and fn are switched.
doWhilst is to whilst as do while is to while in plain JavaScript.
 ### until(test, fn, callback)
Repeatedly call fn until test returns true. Calls callback when stopped, or an error occurs.
The inverse of [whilst](#whilst).
 ### doUntil(fn, test, callback)
Like [doWhilst](#doWhilst), except the test is inverted. Note the argument ordering differs from until.
 ### forever(fn, errback)
Calls the asynchronous function fn with a callback parameter that allows it to call itself again, in series, indefinitely.
If an error is passed to the callback then errback is called with the error, and execution stops, otherwise it will never be called.
- function(next) {
- // next is suitable for passing to things that need a callback(err [, whatever]); // it will result in this function being called again.
}, function(err) {
// if next is called with a value in its first parameter, it will appear // in here as ‘err’, and execution will stop.}
);¶
 ### waterfall(tasks, [callback])
Runs the tasks array of functions in series, each passing their results to the next in the array. However, if any of the tasks pass an error to their own callback, the next function is not executed, and the main callback is immediately called with the error.
__Arguments__
- tasks - An array of functions to run, each function is passed a callback(err, result1, result2, ...) it must call on completion. The first argument is an error (which can be null) and any further arguments will be passed as arguments in order to the next task.
- callback(err, [results]) - An optional callback to run once all the functions have completed. This will be passed the results of the last task’s callback.
__Example__
- function(callback) {
- callback(null, ‘one’, ‘two’);
}, function(arg1, arg2, callback) {
- // arg1 now equals ‘one’ and arg2 now equals ‘two’
- callback(null, ‘three’);
}, function(arg1, callback) {
// arg1 now equals ‘three’ callback(null, ‘done’);}
- ], function (err, result) {
- // result now equals ‘done’
});¶
Creates a function which is a composition of the passed asynchronous functions. Each function consumes the return value of the function that follows. Composing functions f(), g(), and h() would produce the result of f(g(h())), only this version uses callbacks to obtain the return values.
Each function is executed with the this binding of the composed function.
__Arguments__
- functions... - the asynchronous functions to compose
__Example__
```js function add1(n, callback) {
- setTimeout(function () {
- callback(null, n + 1);
}, 10);
}
- function mul3(n, callback) {
- setTimeout(function () {
- callback(null, n * 3);
}, 10);
}
var add1mul3 = async.compose(mul3, add1);
- add1mul3(4, function (err, result) {
- // result now equals 15
});¶
Version of the compose function that is more natural to read. Each function consumes the return value of the previous function. It is the equivalent of [compose](#compose) with the arguments reversed.
Each function is executed with the this binding of the composed function.
__Arguments__
- functions... - the asynchronous functions to compose
__Example__
``js // Requires lodash (or underscore), express3 and dresende’s orm2. // Part of an app, that fetches cats of the logged user. // This example uses `seq function to avoid overnesting and error // handling clutter. app.get(‘/cats’, function(request, response) {
var User = request.models.User; async.seq(
_.bind(User.get, User), // ‘User.get’ has signature (id, callback(err, data)) function(user, fn) {
user.getCats(fn); // ‘getCats’ has signature (callback(err, data))}
- )(req.session.user_id, function (err, cats) {
- if (err) {
- console.error(err); response.json({ status: ‘error’, message: err.message });
- } else {
- response.json({ status: ‘ok’, message: ‘Cats found’, data: cats });
}
});
});¶
Applies the provided arguments to each function in the array, calling callback after all functions have completed. If you only provide the first argument, then it will return a function which lets you pass in the arguments as if it were a single function call.
__Arguments__
- fns - the asynchronous functions to all call with the same arguments
- args... - any number of separate arguments to pass to the function
- callback - the final argument should be the callback, called when all functions have completed processing
__Example__
```js async.applyEach([enableSearch, updateSchema], ‘bucket’, callback);
// partial application example: async.each(
buckets, async.applyEach([enableSearch, updateSchema]), callback
);¶
 ### applyEachSeries(arr, iterator, callback)
The same as [applyEach](#applyEach) only the functions are applied in series.
 ### queue(worker, concurrency)
Creates a queue object with the specified concurrency. Tasks added to the queue are processed in parallel (up to the concurrency limit). If all worker`s are in progress, the task is queued until one becomes available. Once a `worker completes a task, that task‘s callback is called.
__Arguments__
- worker(task, callback) - An asynchronous function for processing a queued task, which must call its callback(err) argument when finished, with an optional error as an argument.
- concurrency - An integer for determining how many worker functions should be run in parallel.
__Queue objects__
The queue object returned by this function has the following properties and methods:
length() - a function returning the number of items waiting to be processed.
started - a function returning whether or not any items have been pushed and processed by the queue
running() - a function returning the number of items currently being processed.
idle() - a function returning false if there are items waiting or being processed, or true if not.
concurrency - an integer for determining how many worker functions should be run in parallel. This property can be changed after a queue is created to alter the concurrency on-the-fly.
push(task, [callback]) - add a new task to the queue. Calls callback once the worker has finished processing the task. Instead of a single task, a tasks array can be submitted. The respective callback is used for every task in the list.
unshift(task, [callback]) - add a new task to the front of the queue.
- saturated - a callback that is called when the queue length hits the concurrency limit,
and further tasks will be queued.
empty - a callback that is called when the last item from the queue is given to a worker.
drain - a callback that is called when the last item from the queue has returned from the worker.
paused - a boolean for determining whether the queue is in a paused state
pause() - a function that pauses the processing of tasks until resume() is called.
resume() - a function that resumes the processing of queued tasks when the queue is paused.
kill() - a function that removes the drain callback and empties remaining tasks from the queue forcing it to go idle.
__Example__
```js // create a queue object with concurrency 2
- var q = async.queue(function (task, callback) {
- console.log(‘hello ‘ + task.name); callback();
}, 2);
// assign a callback q.drain = function() {
console.log(‘all items have been processed’);
}
// add some items to the queue
- q.push({name: ‘foo’}, function (err) {
- console.log(‘finished processing foo’);
}); q.push({name: ‘bar’}, function (err) {
console.log(‘finished processing bar’);
});
// add some items to the queue (batch-wise)
- q.push([{name: ‘baz’},{name: ‘bay’},{name: ‘bax’}], function (err) {
- console.log(‘finished processing item’);
});
// add some items to the front of the queue
- q.unshift({name: ‘bar’}, function (err) {
- console.log(‘finished processing bar’);
});¶
<a name=”priorityQueue” /> ### priorityQueue(worker, concurrency)
The same as [queue](#queue) only tasks are assigned a priority and completed in ascending priority order. There are two differences between queue and priorityQueue objects:
- push(task, priority, [callback]) - priority should be a number. If an array of tasks is given, all tasks will be assigned the same priority.
- The unshift method was removed.
<a name=”cargo” /> ### cargo(worker, [payload])
Creates a cargo object with the specified payload. Tasks added to the cargo will be processed altogether (up to the payload limit). If the worker is in progress, the task is queued until it becomes available. Once the worker has completed some tasks, each callback of those tasks is called. Check out [this animation](https://camo.githubusercontent.com/6bbd36f4cf5b35a0f11a96dcd2e97711ffc2fb37/68747470733a2f2f662e636c6f75642e6769746875622e636f6d2f6173736574732f313637363837312f36383130382f62626330636662302d356632392d313165322d393734662d3333393763363464633835382e676966) for how cargo and queue work.
While [queue](#queue) passes only one task to one of a group of workers at a time, cargo passes an array of tasks to a single worker, repeating when the worker is finished.
__Arguments__
- worker(tasks, callback) - An asynchronous function for processing an array of queued tasks, which must call its callback(err) argument when finished, with an optional err argument.
- payload - An optional integer for determining how many tasks should be processed per round; if omitted, the default is unlimited.
__Cargo objects__
The cargo object returned by this function has the following properties and methods:
- length() - A function returning the number of items waiting to be processed.
- payload - An integer for determining how many tasks should be process per round. This property can be changed after a cargo is created to alter the payload on-the-fly.
- push(task, [callback]) - Adds task to the queue. The callback is called once the worker has finished processing the task. Instead of a single task, an array of tasks can be submitted. The respective callback is used for every task in the list.
- saturated - A callback that is called when the queue.length() hits the concurrency and further tasks will be queued.
- empty - A callback that is called when the last item from the queue is given to a worker.
- drain - A callback that is called when the last item from the queue has returned from the worker.
__Example__
```js // create a cargo object with payload 2
- var cargo = async.cargo(function (tasks, callback) {
- for(var i=0; i<tasks.length; i++){
- console.log(‘hello ‘ + tasks[i].name);
} callback();
}, 2);
// add some items
- cargo.push({name: ‘foo’}, function (err) {
- console.log(‘finished processing foo’);
}); cargo.push({name: ‘bar’}, function (err) {
console.log(‘finished processing bar’);
}); cargo.push({name: ‘baz’}, function (err) {
console.log(‘finished processing baz’);
});¶
 ### auto(tasks, [callback])
Determines the best order for running the functions in tasks, based on their requirements. Each function can optionally depend on other functions being completed first, and each function is run as soon as its requirements are satisfied.
If any of the functions pass an error to their callback, it will not complete (so any other functions depending on it will not run), and the main callback is immediately called with the error. Functions also receive an object containing the results of functions which have completed so far.
Note, all functions are called with a results object as a second argument, so it is unsafe to pass functions in the tasks object which cannot handle the extra argument.
For example, this snippet of code:
readData: async.apply(fs.readFile, ‘data.txt’, ‘utf-8’)
will have the effect of calling readFile with the results object as the last argument, which will fail:
`js
fs.readFile('data.txt', 'utf-8', cb, {});
`
Instead, wrap the call to readFile in a function which does not forward the results object:
- readData: function(cb, results){
- fs.readFile(‘data.txt’, ‘utf-8’, cb);
}
__Arguments__
- tasks - An object. Each of its properties is either a function or an array of requirements, with the function itself the last item in the array. The object’s key of a property serves as the name of the task defined by that property, i.e. can be used when specifying requirements for other tasks. The function receives two arguments: (1) a callback(err, result) which must be called when finished, passing an error (which can be null) and the result of the function’s execution, and (2) a results object, containing the results of the previously executed functions.
- callback(err, results) - An optional callback which is called when all the tasks have been completed. It receives the err argument if any tasks pass an error to their callback. Results are always returned; however, if an error occurs, no further tasks will be performed, and the results object will only contain partial results.
__Example__
- get_data: function(callback){
- console.log(‘in get_data’); // async code to get some data callback(null, ‘data’, ‘converted to array’);
}, make_folder: function(callback){
console.log(‘in make_folder’); // async code to create a directory to store a file in // this is run at the same time as getting the data callback(null, ‘folder’);}, write_file: [‘get_data’, ‘make_folder’, function(callback, results){
console.log(‘in write_file’, JSON.stringify(results)); // once there is some data and the directory exists, // write the data to a file in the directory callback(null, ‘filename’);}], email_link: [‘write_file’, function(callback, results){
console.log(‘in email_link’, JSON.stringify(results)); // once the file is written let’s email a link to it... // results.write_file contains the filename returned by write_file. callback(null, {‘file’:results.write_file, ‘email’:'user@example.com‘});}]
- }, function(err, results) {
- console.log(‘err = ‘, err); console.log(‘results = ‘, results);
});¶
This is a fairly trivial example, but to do this using the basic parallel and series functions would look like this:
- function(callback){
- console.log(‘in get_data’); // async code to get some data callback(null, ‘data’, ‘converted to array’);
}, function(callback){
console.log(‘in make_folder’); // async code to create a directory to store a file in // this is run at the same time as getting the data callback(null, ‘folder’);}
], function(err, results){
- async.series([
- function(callback){
- console.log(‘in write_file’, JSON.stringify(results)); // once there is some data and the directory exists, // write the data to a file in the directory results.push(‘filename’); callback(null);
}, function(callback){
console.log(‘in email_link’, JSON.stringify(results)); // once the file is written let’s email a link to it... callback(null, {‘file’:results.pop(), ‘email’:'user@example.com‘});}
]);
});¶
For a complicated series of async tasks, using the [auto](#auto) function makes adding new tasks much easier (and the code more readable).
 ### retry([times = 5], task, [callback])
Attempts to get a successful response from task no more than times times before returning an error. If the task is successful, the callback will be passed the result of the successful task. If all attempts fail, the callback will be passed the error and result (if any) of the final attempt.
__Arguments__
- times - An integer indicating how many times to attempt the task before giving up. Defaults to 5.
- task(callback, results) - A function which receives two arguments: (1) a callback(err, result) which must be called when finished, passing err (which can be null) and the result of the function’s execution, and (2) a results object, containing the results of the previously executed functions (if nested inside another control flow).
- callback(err, results) - An optional callback which is called when the task has succeeded, or after the final failed attempt. It receives the err and result arguments of the last attempt at completing the task.
The [retry](#retry) function can be used as a stand-alone control flow by passing a callback, as shown below:
```js async.retry(3, apiMethod, function(err, result) {
// do something with the result
});¶
It can also be embeded within other control flow functions to retry individual methods that are not as reliable, like this:
users: api.getUsers.bind(api), payments: async.retry(3, api.getPayments.bind(api))
- }, function(err, results) {
- // do something with the results
});¶
<a name=”iterator” /> ### iterator(tasks)
Creates an iterator function which calls the next function in the tasks array, returning a continuation to call the next one after that. It’s also possible to “peek” at the next iterator with iterator.next().
This function is used internally by the async module, but can be useful when you want to manually control the flow of functions in series.
__Arguments__
- tasks - An array of functions to run.
__Example__
```js var iterator = async.iterator([
function(){ sys.p(‘one’); }, function(){ sys.p(‘two’); }, function(){ sys.p(‘three’); }
]);
node> var iterator2 = iterator(); ‘one’ node> var iterator3 = iterator2(); ‘two’ node> iterator3(); ‘three’ node> var nextfn = iterator2.next(); node> nextfn(); ‘three’ ```
<a name=”apply” /> ### apply(function, arguments..)
Creates a continuation function with some arguments already applied.
Useful as a shorthand when combined with other control flow functions. Any arguments passed to the returned function are added to the arguments originally passed to apply.
__Arguments__
- function - The function you want to eventually apply all arguments to.
- arguments... - Any number of arguments to automatically apply when the continuation is called.
__Example__
- async.parallel([
- async.apply(fs.writeFile, ‘testfile1’, ‘test1’), async.apply(fs.writeFile, ‘testfile2’, ‘test2’),
]);
// the same process without using apply
- async.parallel([
- function(callback){
- fs.writeFile(‘testfile1’, ‘test1’, callback);
}, function(callback){
fs.writeFile(‘testfile2’, ‘test2’, callback);}
]);¶
It’s possible to pass any number of additional arguments when calling the continuation:
`js
node> var fn = async.apply(sys.puts, 'one');
node> fn('two', 'three');
one
two
three
`
<a name=”nextTick” /> ### nextTick(callback), setImmediate(callback)
Calls callback on a later loop around the event loop. In Node.js this just calls process.nextTick; in the browser it falls back to setImmediate(callback) if available, otherwise setTimeout(callback, 0), which means other higher priority events may precede the execution of callback.
This is used internally for browser-compatibility purposes.
__Arguments__
- callback - The function to call on a later loop around the event loop.
__Example__
```js var call_order = []; async.nextTick(function(){
call_order.push(‘two’); // call_order now equals [‘one’,’two’]
}); call_order.push(‘one’) ```
<a name=”times” /> ### times(n, callback)
Calls the callback function n times, and accumulates results in the same manner you would use with [map](#map).
__Arguments__
- n - The number of times to run the function.
- callback - The function to call n times.
__Example__
```js // Pretend this is some complicated async factory var createUser = function(id, callback) {
- callback(null, {
- id: ‘user’ + id
})
} // generate 5 users async.times(5, function(n, next){
- createUser(n, function(err, user) {
- next(err, user)
})
- }, function(err, users) {
- // we should now have 5 users
});¶
 ### timesSeries(n, callback)
The same as [times](#times), only the iterator is applied to each item in arr in series. The next iterator is only called once the current one has completed. The results array will be in the same order as the original.
## Utils
 ### memoize(fn, [hasher])
Caches the results of an async function. When creating a hash to store function results against, the callback is omitted from the hash and an optional hash function can be used.
The cache of results is exposed as the memo property of the function returned by memoize.
__Arguments__
- fn - The function to proxy and cache results from.
- hasher - Tn optional function for generating a custom hash for storing results. It has all the arguments applied to it apart from the callback, and must be synchronous.
__Example__
```js var slow_fn = function (name, callback) {
// do something callback(null, result);
}; var fn = async.memoize(slow_fn);
// fn can now be used as if it were slow_fn fn(‘some name’, function () {
// callback
});¶
<a name=”unmemoize” /> ### unmemoize(fn)
Undoes a [memoize](#memoize)d function, reverting it to the original, unmemoized form. Handy for testing.
__Arguments__
- fn - the memoized function
<a name=”log” /> ### log(function, arguments)
Logs the result of an async function to the console. Only works in Node.js or in browsers that support console.log and console.error (such as FF and Chrome). If multiple arguments are returned from the async function, console.log is called on each argument in order.
__Arguments__
- function - The function you want to eventually apply all arguments to.
- arguments... - Any number of arguments to apply to the function.
__Example__
```js var hello = function(name, callback){
- setTimeout(function(){
- callback(null, ‘hello ‘ + name);
}, 1000);
};¶
`js
node> async.log(hello, 'world');
'hello world'
`
 ### dir(function, arguments)
Logs the result of an async function to the console using console.dir to display the properties of the resulting object. Only works in Node.js or in browsers that support console.dir and console.error (such as FF and Chrome). If multiple arguments are returned from the async function, console.dir is called on each argument in order.
__Arguments__
- function - The function you want to eventually apply all arguments to.
- arguments... - Any number of arguments to apply to the function.
__Example__
```js var hello = function(name, callback){
- setTimeout(function(){
- callback(null, {hello: name});
}, 1000);
};¶
`js
node> async.dir(hello, 'world');
{hello: 'world'}
`
 ### noConflict()
Changes the value of async back to its original value, returning a reference to the async object.


Welcome to Web login
By Siczones
Remember me
Forgot the password?
Who are you? Roles?
close[×]
Login
Reset
Copyright © 2016 - Siczones.


FAQ
What is CheatBreaker?CheatBreaker is a modpack! In most cases, CheatBreaker more than doubles your normal Minecraft frames!
Are you the Official CheatBreaker?No, and we will never claim otherwise. We are an edited version in order to help maintain the feel of CheatBreaker whilst also trying to help patch issues and provide new features. We are in no way, shape or form affiliated with CheatBreaker, LLC. Please make sure to read the official security statement put out by the CheatBreaker team: https://github.com/cheatbreaker/security-advisory
Does it really boost my frames?With a little bit of magic, yes! In most cases, your frames will more than double.
Can I use it on any server?Of course! You are welcome to use the CheatBreaker client on any 1.7 server.
Is it really free?CheatBreaker is free, yes! This is possible because CheatBreaker was funded and developed by the creators of successful server networks such as the MineHQ Network and the Arcane Network. This version is maintained by the Protocol Network at no extra cost!
Can I use my own texture pack?Yes, absolutely! However, CheatBreaker will not allow you to load “xray texture packs”.
Will CheatBreaker have access to my personal information?In short, no. CheatBreaker creates and stores your encrypted IP address in order to make sure nobody can use your account at the same time. CheatBreaker will only use the data for security checks. On occasion, we may transmit your process memory, to our servers for inspection. We will never, under any circumstance, transmit data for malicious intent.
I scanned the CheatBreaker and it is flagging this AntiVirus/VirusTotalThis is due to obfuscation used within the CheatBreaker Client - which would flag: - Java.Trojan.GenericGBA.20353 - Java.Trojan.GenericGBA.D4F81 - Trojan.Java.GenericGBA Another reason of this flagging is due to the use of a WebSocket which uses a Direct URL connection in order to get your cosmetic data and friends, if you need more support on making sure this is safe, please message us on our Discord or Telegram.
Does CheatBreaker support MacOS or Linux?Yup! With a little bit of magic done by the Protocol Team, you can run CheatBreaker on MacOS and Linux as long as you are using Oracle JDK. (Not OpenJDK sadly!)
Which mods can I use?You can only use mods that are provided by the client, you may not use your own mods.
I found an issue, where can I report it?
We want to work closely with our community to create an awesome experience for our users. If you have something you think is worth sharing with us, please message us via the Telegram Chat or Discord and we will investigate your report
promptly.
Those who responsibly disclose issues related to the client may receive monetary rewards and/or an exclusive cape


This is an experimental drum machine powered by a deep neural network. To use it, define a seed pattern on the left, and use the “generate” button. A neural network will dream up a continuation to your seed pattern.
Using the Drums RNN (pretrained) model from Google Magenta, and Magenta.js + TensorFlow.js + Tone.js.
A pen by @teropa.


{% extends 'layouts/base.html' %} {% load static from staticfiles %} {% load crispy_forms_tags %} {% block back_link %}{% endblock %} {% block title %}Add denial records{% endblock %} {% block body %}
Add denial records into LITE by uploading a .csv file


As you read this, someone is working away trying to bring the service back up. Please check back later.
If you feel this message has been here for too long, please contact submit@cs.ucsb.edu.