protocol/mesos/ShuffleServiceHeartbeat.java

0001 /*
0002  * Licensed to the Apache Software Foundation (ASF) under one or more
0003  * contributor license agreements.  See the NOTICE file distributed with
0004  * this work for additional information regarding copyright ownership.
0005  * The ASF licenses this file to You under the Apache License, Version 2.0
0006  * (the "License"); you may not use this file except in compliance with
0007  * the License.  You may obtain a copy of the License at
0008  *
0009  *    http://www.apache.org/licenses/LICENSE-2.0
0010  *
0011  * Unless required by applicable law or agreed to in writing, software
0012  * distributed under the License is distributed on an "AS IS" BASIS,
0013  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
0014  * See the License for the specific language governing permissions and
0015  * limitations under the License.
0016  */
0017
0018 package org.apache.spark.network.shuffle.protocol.mesos;
0019
0020 import io.netty.buffer.ByteBuf;
0021 import org.apache.spark.network.protocol.Encoders;
0022 import org.apache.spark.network.shuffle.protocol.BlockTransferMessage;
0023
0024 // Needed by ScalaDoc. See SPARK-7726
0025 import static org.apache.spark.network.shuffle.protocol.BlockTransferMessage.Type;
0026
0027 /**
0028  * A heartbeat sent from the driver to the MesosExternalShuffleService.
0029  */
0030 public class ShuffleServiceHeartbeat extends BlockTransferMessage {
0031   private final String appId;
0032
0033   public ShuffleServiceHeartbeat(String appId) {
0034     this.appId = appId;
0035   }
0036
0037   public String getAppId() { return appId; }
0038
0039   @Override
0040   protected Type type() { return Type.HEARTBEAT; }
0041
0042   @Override
0043   public int encodedLength() { return Encoders.Strings.encodedLength(appId); }
0044
0045   @Override
0046   public void encode(ByteBuf buf) {
0047     Encoders.Strings.encode(buf, appId);
0048   }
0049
0050   public static ShuffleServiceHeartbeat decode(ByteBuf buf) {
0051     return new ShuffleServiceHeartbeat(Encoders.Strings.decode(buf));
0052   }
0053 }