Communication

Communication provides convenience functionality to communicate between a client and server (two-way) via WebSockets. The supported mechanisms are methods and shared variables.

Method Example:

@server def time: Future[Long]

Notice the

@server

annotation. This represents that this method will be defined in the server implementation allowing the client to call the method and it is invoked on the server and the result is received on the client. To create a method in the client that is called from the server simply use the

@client

annotation instead. The return type of the method must be of

Future

or it will be ignored.

Shared Var Example:

val name: reactify.Var[String] = shared[String]("Default")

This represents a variable that is shared between the client and server. Either can change the value and it will be reflected in the other asynchronously. We use Reactify's

Var

because it allows functional reactive observing of changes.

Note that three traits must be defined for a

Communication

: 1. Shared Interface (defined as the definition of each method and shared variable):

    trait ExampleCommunication extends Communication {
      @server def time: Future[Long]
      @client def url: Future[String]
      val name: Var[String] = shared[String]("Default")
    }
  2. Client Interface (defined in Scala.js code):
      trait ClientExampleCommunication extends ExampleCommunication {
      override def url: Future[String] = Future.successful(document.url.href)
    }

3. Server Interface (defined in JVM code):
    trait ServerExampleCommunication extends ExampleCommunication {
      override def time: Future[Long] = Future.successful(System.currentTimeMillis())
    }


Notice that only the methods that need to be implemented on the client or server are defined. The rest are generated
at compile-time.

Communication

1. Shared Interface (defined as the definition of each method and shared variable):
    trait ExampleCommunication extends Communication {
      @server def time: Future[Long]
      @client def url: Future[String]
      val name: Var[String] = shared[String]("Default")
    }
  2. Client Interface (defined in Scala.js code):
      trait ClientExampleCommunication extends ExampleCommunication {
      override def url: Future[String] = Future.successful(document.url.href)
    }

3. Server Interface (defined in JVM code):
    trait ServerExampleCommunication extends ExampleCommunication {
      override def time: Future[Long] = Future.successful(System.currentTimeMillis())
    }


Notice that only the methods that need to be implemented on the client or server are defined. The rest are generated
at compile-time.

Var

observing of changes.

Note that three traits must be defined for a 
Communication

:
1. Shared Interface (defined as the definition of each method and shared variable):
    trait ExampleCommunication extends Communication {
      @server def time: Future[Long]
      @client def url: Future[String]
      val name: Var[String] = shared[String]("Default")
    }
  2. Client Interface (defined in Scala.js code):
      trait ClientExampleCommunication extends ExampleCommunication {
      override def url: Future[String] = Future.successful(document.url.href)
    }

3. Server Interface (defined in JVM code):
    trait ServerExampleCommunication extends ExampleCommunication {
      override def time: Future[Long] = Future.successful(System.currentTimeMillis())
    }


Notice that only the methods that need to be implemented on the client or server are defined. The rest are generated
at compile-time.

Communication

1. Shared Interface (defined as the definition of each method and shared variable):
    trait ExampleCommunication extends Communication {
      @server def time: Future[Long]
      @client def url: Future[String]
      val name: Var[String] = shared[String]("Default")
    }
  2. Client Interface (defined in Scala.js code):
      trait ClientExampleCommunication extends ExampleCommunication {
      override def url: Future[String] = Future.successful(document.url.href)
    }

3. Server Interface (defined in JVM code):
    trait ServerExampleCommunication extends ExampleCommunication {
      override def time: Future[Long] = Future.successful(System.currentTimeMillis())
    }


Notice that only the methods that need to be implemented on the client or server are defined. The rest are generated
at compile-time.

Future


Shared Var Example:

val name: reactify.Var[String] = shared[String]("Default")


This represents a variable that is shared between the client and server. Either can change the value and it will be
reflected in the other asynchronously. We use Reactify's 
Var

 because it allows functional reactive
observing of changes.

Note that three traits must be defined for a 
Communication

:
1. Shared Interface (defined as the definition of each method and shared variable):
    trait ExampleCommunication extends Communication {
      @server def time: Future[Long]
      @client def url: Future[String]
      val name: Var[String] = shared[String]("Default")
    }
  2. Client Interface (defined in Scala.js code):
      trait ClientExampleCommunication extends ExampleCommunication {
      override def url: Future[String] = Future.successful(document.url.href)
    }

3. Server Interface (defined in JVM code):
    trait ServerExampleCommunication extends ExampleCommunication {
      override def time: Future[Long] = Future.successful(System.currentTimeMillis())
    }


Notice that only the methods that need to be implemented on the client or server are defined. The rest are generated
at compile-time.

Communication

1. Shared Interface (defined as the definition of each method and shared variable):
    trait ExampleCommunication extends Communication {
      @server def time: Future[Long]
      @client def url: Future[String]
      val name: Var[String] = shared[String]("Default")
    }
  2. Client Interface (defined in Scala.js code):
      trait ClientExampleCommunication extends ExampleCommunication {
      override def url: Future[String] = Future.successful(document.url.href)
    }

3. Server Interface (defined in JVM code):
    trait ServerExampleCommunication extends ExampleCommunication {
      override def time: Future[Long] = Future.successful(System.currentTimeMillis())
    }


Notice that only the methods that need to be implemented on the client or server are defined. The rest are generated
at compile-time.

Var

observing of changes.

Note that three traits must be defined for a 
Communication

:
1. Shared Interface (defined as the definition of each method and shared variable):
    trait ExampleCommunication extends Communication {
      @server def time: Future[Long]
      @client def url: Future[String]
      val name: Var[String] = shared[String]("Default")
    }
  2. Client Interface (defined in Scala.js code):
      trait ClientExampleCommunication extends ExampleCommunication {
      override def url: Future[String] = Future.successful(document.url.href)
    }

3. Server Interface (defined in JVM code):
    trait ServerExampleCommunication extends ExampleCommunication {
      override def time: Future[Long] = Future.successful(System.currentTimeMillis())
    }


Notice that only the methods that need to be implemented on the client or server are defined. The rest are generated
at compile-time.

Communication

1. Shared Interface (defined as the definition of each method and shared variable):
    trait ExampleCommunication extends Communication {
      @server def time: Future[Long]
      @client def url: Future[String]
      val name: Var[String] = shared[String]("Default")
    }
  2. Client Interface (defined in Scala.js code):
      trait ClientExampleCommunication extends ExampleCommunication {
      override def url: Future[String] = Future.successful(document.url.href)
    }

3. Server Interface (defined in JVM code):
    trait ServerExampleCommunication extends ExampleCommunication {
      override def time: Future[Long] = Future.successful(System.currentTimeMillis())
    }


Notice that only the methods that need to be implemented on the client or server are defined. The rest are generated
at compile-time.

@server

implementation allowing the client to call the method and it is invoked on the server and the result is received on
the client. To create a method in the client that is called from the server simply use the 
@client

annotation instead. The return type of the method must be of 
Future

 or it will be ignored.

Shared Var Example:

val name: reactify.Var[String] = shared[String]("Default")


This represents a variable that is shared between the client and server. Either can change the value and it will be
reflected in the other asynchronously. We use Reactify's 
Var

 because it allows functional reactive
observing of changes.

Note that three traits must be defined for a 
Communication

:
1. Shared Interface (defined as the definition of each method and shared variable):
    trait ExampleCommunication extends Communication {
      @server def time: Future[Long]
      @client def url: Future[String]
      val name: Var[String] = shared[String]("Default")
    }
  2. Client Interface (defined in Scala.js code):
      trait ClientExampleCommunication extends ExampleCommunication {
      override def url: Future[String] = Future.successful(document.url.href)
    }

3. Server Interface (defined in JVM code):
    trait ServerExampleCommunication extends ExampleCommunication {
      override def time: Future[Long] = Future.successful(System.currentTimeMillis())
    }


Notice that only the methods that need to be implemented on the client or server are defined. The rest are generated
at compile-time.

Communication

1. Shared Interface (defined as the definition of each method and shared variable):
    trait ExampleCommunication extends Communication {
      @server def time: Future[Long]
      @client def url: Future[String]
      val name: Var[String] = shared[String]("Default")
    }
  2. Client Interface (defined in Scala.js code):
      trait ClientExampleCommunication extends ExampleCommunication {
      override def url: Future[String] = Future.successful(document.url.href)
    }

3. Server Interface (defined in JVM code):
    trait ServerExampleCommunication extends ExampleCommunication {
      override def time: Future[Long] = Future.successful(System.currentTimeMillis())
    }


Notice that only the methods that need to be implemented on the client or server are defined. The rest are generated
at compile-time.

Var

observing of changes.

Note that three traits must be defined for a 
Communication

:
1. Shared Interface (defined as the definition of each method and shared variable):
    trait ExampleCommunication extends Communication {
      @server def time: Future[Long]
      @client def url: Future[String]
      val name: Var[String] = shared[String]("Default")
    }
  2. Client Interface (defined in Scala.js code):
      trait ClientExampleCommunication extends ExampleCommunication {
      override def url: Future[String] = Future.successful(document.url.href)
    }

3. Server Interface (defined in JVM code):
    trait ServerExampleCommunication extends ExampleCommunication {
      override def time: Future[Long] = Future.successful(System.currentTimeMillis())
    }


Notice that only the methods that need to be implemented on the client or server are defined. The rest are generated
at compile-time.

Communication

1. Shared Interface (defined as the definition of each method and shared variable):
    trait ExampleCommunication extends Communication {
      @server def time: Future[Long]
      @client def url: Future[String]
      val name: Var[String] = shared[String]("Default")
    }
  2. Client Interface (defined in Scala.js code):
      trait ClientExampleCommunication extends ExampleCommunication {
      override def url: Future[String] = Future.successful(document.url.href)
    }

3. Server Interface (defined in JVM code):
    trait ServerExampleCommunication extends ExampleCommunication {
      override def time: Future[Long] = Future.successful(System.currentTimeMillis())
    }


Notice that only the methods that need to be implemented on the client or server are defined. The rest are generated
at compile-time.

Future


Shared Var Example:

val name: reactify.Var[String] = shared[String]("Default")


This represents a variable that is shared between the client and server. Either can change the value and it will be
reflected in the other asynchronously. We use Reactify's 
Var

 because it allows functional reactive
observing of changes.

Note that three traits must be defined for a 
Communication

:
1. Shared Interface (defined as the definition of each method and shared variable):
    trait ExampleCommunication extends Communication {
      @server def time: Future[Long]
      @client def url: Future[String]
      val name: Var[String] = shared[String]("Default")
    }
  2. Client Interface (defined in Scala.js code):
      trait ClientExampleCommunication extends ExampleCommunication {
      override def url: Future[String] = Future.successful(document.url.href)
    }

3. Server Interface (defined in JVM code):
    trait ServerExampleCommunication extends ExampleCommunication {
      override def time: Future[Long] = Future.successful(System.currentTimeMillis())
    }


Notice that only the methods that need to be implemented on the client or server are defined. The rest are generated
at compile-time.

Communication

1. Shared Interface (defined as the definition of each method and shared variable):
    trait ExampleCommunication extends Communication {
      @server def time: Future[Long]
      @client def url: Future[String]
      val name: Var[String] = shared[String]("Default")
    }
  2. Client Interface (defined in Scala.js code):
      trait ClientExampleCommunication extends ExampleCommunication {
      override def url: Future[String] = Future.successful(document.url.href)
    }

3. Server Interface (defined in JVM code):
    trait ServerExampleCommunication extends ExampleCommunication {
      override def time: Future[Long] = Future.successful(System.currentTimeMillis())
    }


Notice that only the methods that need to be implemented on the client or server are defined. The rest are generated
at compile-time.

Var

observing of changes.

Note that three traits must be defined for a 
Communication

:
1. Shared Interface (defined as the definition of each method and shared variable):
    trait ExampleCommunication extends Communication {
      @server def time: Future[Long]
      @client def url: Future[String]
      val name: Var[String] = shared[String]("Default")
    }
  2. Client Interface (defined in Scala.js code):
      trait ClientExampleCommunication extends ExampleCommunication {
      override def url: Future[String] = Future.successful(document.url.href)
    }

3. Server Interface (defined in JVM code):
    trait ServerExampleCommunication extends ExampleCommunication {
      override def time: Future[Long] = Future.successful(System.currentTimeMillis())
    }


Notice that only the methods that need to be implemented on the client or server are defined. The rest are generated
at compile-time.

Communication

1. Shared Interface (defined as the definition of each method and shared variable):
    trait ExampleCommunication extends Communication {
      @server def time: Future[Long]
      @client def url: Future[String]
      val name: Var[String] = shared[String]("Default")
    }
  2. Client Interface (defined in Scala.js code):
      trait ClientExampleCommunication extends ExampleCommunication {
      override def url: Future[String] = Future.successful(document.url.href)
    }

3. Server Interface (defined in JVM code):
    trait ServerExampleCommunication extends ExampleCommunication {
      override def time: Future[Long] = Future.successful(System.currentTimeMillis())
    }


Notice that only the methods that need to be implemented on the client or server are defined. The rest are generated
at compile-time.

See also: io.youi.app.YouIApplication for usage examples

Linear Supertypes

ErrorSupport, AnyRef, Any

Related Docs: object Communication | package communication

trait Communication extends ErrorSupport

Abstract Value Members

abstract def connection: Connection

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val comm: CommunicationInternal

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def error(t: Throwable): Unit

def errorSupport[R](f: ⇒ R): R

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

macro def shared[T](default: T): Var[T]

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

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from ErrorSupport

Inherited from AnyRef

Inherited from Any

Ungrouped