content: /*
   * Copyright (C) 2020 ActiveJ LLC.
   *
   * 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 io.activej.net.socket.udp;
  
  import io.activej.bytebuf.ByteBuf;
  import org.jetbrains.annotations.Nullable;
  
  import java.net.InetSocketAddress;
  
  import static io.activej.common.Checks.checkNotNull;
  import static io.activej.common.Utils.nullify;
  
  /**
   * This class represents a UDP packet.
   * Each message is routed from one machine to another based solely on information contained within that packet
   */
  public final class UdpPacket {
  	/**
  	 * The data buffer to send
  	 */
  	private @Nullable ByteBuf buf;
  	/**
  	 * The address to which the packet should be sent or from which it
  	 * was received.
  	 */
  	private final InetSocketAddress inetSocketAddress;
  
  	private UdpPacket(@Nullable ByteBuf buf, InetSocketAddress inetSocketAddress) {
  		this.buf = buf;
  		this.inetSocketAddress = inetSocketAddress;
  	}
  
  	/**
  	 * Creates a new instance of UDP packet
  	 *
  	 * @param buf               the data buffer to send or which was received
  	 * @param inetSocketAddress the address to which the packet should be sent or from which it
  	 *                          was received
  	 */
  	public static UdpPacket of(ByteBuf buf, InetSocketAddress inetSocketAddress) {
  		return new UdpPacket(buf, inetSocketAddress);
  	}
  
  	/**
  	 * Returns the data buffer to send or which was received
  	 */
  	public ByteBuf getBuf() {
  		return checkNotNull(buf, "Using UdpPacket after recycling");
  	}
  
  	/**
  	 * Returns the address to which the packet should be sent or from which it
  	 * was received.
  	 */
  	public InetSocketAddress getSocketAddress() {
  		return inetSocketAddress;
  	}
  
  	/**
  	 * Recycles data buffer. You should do it after use.
  	 */
  	public void recycle() {
  		buf = nullify(buf, ByteBuf::recycle);
  	}
  }
  