ip4s-core
3.3.0
API
Generated with
ip4s-core/com.comcast.ip4s/MulticastJoin

MulticastJoin

com.comcast.ip4s.MulticastJoin
See theMulticastJoin companion object
sealed abstract class MulticastJoin[+A <: IpAddress] extends Product with Serializable

Represents a join of a multicast group.

This is represented as an ADT consisting of two constructors, AnySourceMulticastJoin and SourceSpecificMulticastJoin. These constructors are provided as top level types to allow domain modeling where a specific join type is required. The address type is parameterized for a similar reason -- to allow domain modeling where a specific address type is required.

Attributes

Companion:
object
Source:
MulticastJoin.scala
Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
Known subtypes

Members list

Concise view

Value members

Concrete methods

def asAsm: Option[AnySourceMulticastJoin[A]]

Narrows to an AnySourceMulticastJoin.

Narrows to an AnySourceMulticastJoin.

Attributes

Source:
MulticastJoin.scala
def asSsm: Option[SourceSpecificMulticastJoin[A]]

Narrows to a SourceSpecificMulticastJoin.

Narrows to a SourceSpecificMulticastJoin.

Attributes

Source:
MulticastJoin.scala
def fold[B](asm: AnySourceMulticastJoin[A] => B, ssm: SourceSpecificMulticastJoin[A] => B): B

Converts this join to a value of type A using the supplied functions.

Converts this join to a value of type A using the supplied functions.

Attributes

Source:
MulticastJoin.scala
def sourceAndGroup: (Option[A], Multicast[A])

Returns the source address and group address. If this join is an any-source join, None is returned for the source. Otherwise, this join is a source specific join and Some(src) is returned for the source.

Returns the source address and group address. If this join is an any-source join, None is returned for the source. Otherwise, this join is a source specific join and Some(src) is returned for the source.

Attributes

Source:
MulticastJoin.scala
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns:

a string representation of the object.

Definition Classes
Any
Source:
MulticastJoin.scala

Inherited methods

def canEqual(that: Any): Boolean

Attributes

Inherited from:
Equals
def productArity: Int

Attributes

Inherited from:
Product
def productElement(n: Int): Any

Attributes

Inherited from:
Product
def productElementName(n: Int): String

Attributes

Inherited from:
Product
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
def productPrefix: String

Attributes

Inherited from:
Product
Generated with