com.tencent.angel.common.location.LocationManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of angel-ps-core Show documentation
There is a newer version: 3.2.0
/*
 * Tencent is pleased to support the open source community by making Angel available.
 *
 * Copyright (C) 2017-2018 THL A29 Limited, a Tencent company. All rights reserved.
 *
 * 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
 *
 * https://opensource.org/licenses/Apache-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 com.tencent.angel.common.location;

import com.tencent.angel.ps.ParameterServerId;
import com.tencent.angel.psagent.PSAgentId;
import com.tencent.angel.worker.WorkerId;

import java.util.*;
import java.util.concurrent.ConcurrentHashMap;

/**
 * Location manager
 */
public class LocationManager {
  /**
   * Master location
   */
  private volatile Location masterLocation;

  /**
   * PS locations
   */
  private final Map psIdToLocMap;

  /**
   * Worker locations
   */
  private final Map workerIdToLocMap;

  /**
   * All ps ids
   */
  private volatile ParameterServerId[] psIds;

  /**
   * Create a location manager
   */
  public LocationManager() {
    this.masterLocation = null;
    this.psIdToLocMap = new ConcurrentHashMap<>();
    this.workerIdToLocMap = new ConcurrentHashMap<>();
  }

  /**
   * Get master location
   *
   * @return master location
   */
  public Location getMasterLocation() {
    return masterLocation;
  }

  /**
   * Get a ps location
   *
   * @param psId ps id
   * @return ps location
   */
  public Location getPsLocation(ParameterServerId psId) {
    return psIdToLocMap.get(psId);
  }

  /**
   * Get a worker location
   *
   * @param workerId worker id
   * @return worker location
   */
  public Location getWorkerLocation(WorkerId workerId) {
    return workerIdToLocMap.get(workerId);
  }

  /**
   * Set master location
   *
   * @param masterLocation master location
   */
  public void setMasterLocation(Location masterLocation) {
    this.masterLocation = masterLocation;
  }

  /**
   * Set a ps location
   *
   * @param psId ps id
   * @param loc  ps location
   */
  public void setPsLocation(ParameterServerId psId, Location loc) {
    if (loc == null) {
      psIdToLocMap.remove(psId);
    } else {
      psIdToLocMap.put(psId, loc);
    }
  }

  /**
   * Set worker location
   *
   * @param workerId worker id
   * @param loc      worker location
   */
  public void setWorkerLocation(WorkerId workerId, Location loc) {
    workerIdToLocMap.put(workerId, loc);
  }

  /**
   * Set all ps ids
   *
   * @param psIds all ps ids
   */
  public void setPsIds(ParameterServerId[] psIds) {
    this.psIds = psIds;
  }

  /**
   * Get all ps ids
   *
   * @return all ps ids
   */
  public ParameterServerId[] getPsIds() {
    return psIds;
  }

  public void setPSAgentLocation(PSAgentId psAgentId, Location location) {
  }

  /**
   * Are all pss registered
   *
   * @return true mean all pss have registered to master
   */
  public boolean isAllPsRegisted() {
    return (psIds != null) && (psIds.length == psIdToLocMap.size());
  }

  /**
   * Get all ps locations
   *
   * @return all ps locations
   */
  public Map getPsLocations() {
    return psIdToLocMap;
  }
}