Package 

Class TurnCandidateHarvest

  • All Implemented Interfaces:
    org.ice4j.ResponseCollector 
    
public class TurnCandidateHarvest
extends StunCandidateHarvest

    Represents the harvesting of TURN Candidates for a specific HostCandidate performed by a specific TurnCandidateHarvester.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description
      TurnCandidateHarvest(TurnCandidateHarvester harvester, HostCandidate hostCandidate) Initializes a new TurnCandidateHarvest which is to represent the harvesting of TURN Candidates for a specific HostCandidate performed by a specific TurnCandidateHarvester.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      void close(RelayedCandidateDatagramSocket relayedCandidateSocket) Notifies this TurnCandidateHarvest that a specific RelayedCandidateDatagramSocket is closing and that this instance is to delete the associated TURN Allocation.
      Array<byte> sendRequest(RelayedCandidateDatagramSocket relayedCandidateDatagramSocket, Request request) Sends a specific Request on behalf of a specific RelayedCandidateDatagramSocket to the TURN server associated with this TurnCandidateHarvest.

      • Methods inherited from class org.ice4j.ice.harvest.StunCandidateHarvest

        close, processResponse

      • Methods inherited from class org.ice4j.AbstractResponseCollector

        processTimeout, processUnreachable

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • TurnCandidateHarvest

        TurnCandidateHarvest(TurnCandidateHarvester harvester, HostCandidate hostCandidate)
        Initializes a new TurnCandidateHarvest which is to represent the harvesting of TURN Candidates for a specific HostCandidate performed by a specific TurnCandidateHarvester.
        Parameters:
        harvester - the TurnCandidateHarvester which is performing the TURN harvesting
        hostCandidate - the HostCandidate for which TURN Candidates are to be harvested

    • Method Detail

      • close

         void close(RelayedCandidateDatagramSocket relayedCandidateSocket)

        Notifies this TurnCandidateHarvest that a specific RelayedCandidateDatagramSocket is closing and that this instance is to delete the associated TURN Allocation.

        Note: The method is part of the internal API of RelayedCandidateDatagramSocket and TurnCandidateHarvest and is not intended for public use.

        Parameters:
        relayedCandidateSocket - the RelayedCandidateDatagramSocketwhich notifies this instance and which requests that the associated TURN Allocation be deleted

      • sendRequest

         Array<byte> sendRequest(RelayedCandidateDatagramSocket relayedCandidateDatagramSocket, Request request)

        Sends a specific Request on behalf of a specific RelayedCandidateDatagramSocket to the TURN server associated with this TurnCandidateHarvest.

        Parameters:
        relayedCandidateDatagramSocket - the RelayedCandidateDatagramSocket which sends the specified Request and which is to be notified of the result
        request - the Request to be sent to the TURN server associated with this TurnCandidateHarvest