com.sitewhere.spi.microservice.monitoring.IProgressReporter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sitewhere-microservice Show documentation

SiteWhere Microservice Components Library

There is a newer version: 3.0.13

Show newest version

/*
 * Copyright (c) SiteWhere, LLC. All rights reserved. http://www.sitewhere.com
 *
 * The software in this package is published under the terms of the CPAL v1.0
 * license, a copy of which has been included with this distribution in the
 * LICENSE.txt file.
 */
package com.sitewhere.spi.microservice.monitoring;

import com.sitewhere.spi.SiteWhereException;

/**
 * Allows long-running tasks to report their progress.
 */
public interface IProgressReporter {

    /**
     * Report progress for an operation.
     * 
     * @param message
     * @throws SiteWhereException
     */
    void reportProgress(IProgressMessage message) throws SiteWhereException;

    /**
     * Report that an error occurred in a monitored operation.
     * 
     * @param error
     * @throws SiteWhereException
     */
    void reportError(IProgressErrorMessage error) throws SiteWhereException;
}