core/api/src/main/java/org/onlab/onos/store/ClockService.java

package org.onlab.onos.store;

import org.onlab.onos.cluster.MastershipTerm;
import org.onlab.onos.net.DeviceId;

// TODO: Consider renaming to DeviceClockService?
/**
 * Interface for a logical clock service that vends per device timestamps.
 */
public interface ClockService {

    /**
     * Returns a new timestamp for the specified deviceId.
     * @param deviceId device identifier.
     * @return timestamp.
     */
    public Timestamp getTimestamp(DeviceId deviceId);

    // TODO: Should this be here or separate as Admin service, etc.?
    /**
     * Updates the mastership term for the specified deviceId.
     * @param deviceId device identifier.
     * @param term mastership term.
     */
    public void setMastershipTerm(DeviceId deviceId, MastershipTerm term);
}