core/api/src/main/java/org/onosproject/net/device/DeviceClockService.java

/*
 * Copyright 2014 Open Networking Laboratory
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.onlab.onos.net.device;

import org.onlab.onos.net.DeviceId;
import org.onlab.onos.store.Timestamp;

/**
 * Interface for a logical clock service that vends per device timestamps.
 */
public interface DeviceClockService {

    /**
     * Checks if this service can issue Timestamp for specified device.
     *
     * @param deviceId device identifier.
     * @return true if timestamp can be issued for specified device
     */
    public boolean isTimestampAvailable(DeviceId deviceId);

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