org.restcomm.media.ice.harvest

Interface CandidateHarvester

All Known Implementing Classes:

ExternalCandidateHarvester, HostCandidateHarvester

public interface CandidateHarvester

Author:

Henrique Rosa

Method Summary

Methods

Modifier and Type	Method and Description
CandidateType	getCandidateType() Gets the type of candidates gathered by the harvester.
void	harvest(RtpPortManager portManager, IceMediaStream mediaStream, Selector selector) Harvests candidates.

Method Detail

harvest

void harvest(RtpPortManager portManager,
           IceMediaStream mediaStream,
           Selector selector)
             throws HarvestException

Harvests candidates.

Parameters:

portManager - Manages the port range allowed for candidate harvesting.

mediaStream - The media stream to bind the candidate to.

selector - the selector that will be registered to the data channel of the gathered candidates

Throws:

HarvestException - When an error occurs during the candidate harvesting process.

getCandidateType

CandidateType getCandidateType()

Gets the type of candidates gathered by the harvester.

Returns:

The type of harvested candidates