pcap.spi.annotation.Async Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pcap-spi Show documentation

Pcap API specification

There is a newer version: 1.5.1

/*
 * Copyright (c) 2020-2021 Pcap Project
 * SPDX-License-Identifier: MIT OR Apache-2.0
 */
package pcap.spi.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import pcap.spi.PacketHandler;
import pcap.spi.PacketHeader;

/**
 * Indicate the {@link pcap.spi.Pcap#dispatch(int, PacketHandler, Object)} or {@link
 * pcap.spi.Pcap#next(PacketHeader)} is capable to perform non-blocking I/O. The device must be put
 * in non-blocking mode with a call to {@link pcap.spi.Pcap#setNonBlock(boolean)} ({@code true}).
 *
 * @since 1.0.0
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Async {

  /**
   * Get timeout in millisecond.
   *
   * @return returns timeout in millisecond.
   * @since 1.0.0
   */
  int timeout() default -1;
}