Object/Class

nelson.yaml

PortParser

Related Docs: class PortParser | package yaml

Permalink

object PortParser

This parser expects the following syntax to be used when serialising port definitions - all elements are required.

name->port/protocol

Where the elements specifically are:

* name: represents the logical 'name' or 'reference' you want to use this port for. Examples would be 'default' for the default service port, 'monitoring' for the monitoring port, or something like 'mutualtls' for a secure channel. The actual name is not important, but being a short, obvious reference to what it served on that particular port is typically useful.

* port: the actual port number the container binds too when exposing network functionaltiy. It goes without saying that the number must be between 1 and 65535 to form a valid, usable port definition.

* protocol: the protocol used by the service being exposed by this port. This param is used by nelson to know what should be done to the routing tables.

Here are some examples of usage, that are valid and accepted by this parser:

default->9080/https monitoring->4444/tcp

Source
PortParser.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PortParser
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. final case class Error(getMessage: String) extends RuntimeException with Product with Serializable

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. def parse(input: String): Either[Throwable, Port]

    Permalink

    Create a new instance for every usage, as the scala parsers are not thread safe.

    Create a new instance for every usage, as the scala parsers are not thread safe. This was not fixed until 2.12. See SI-4929

  16. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  17. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped