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")
}
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")
}
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")
}
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")
}
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:
Notice the
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 annotation instead. The return type of the method must be of or it will be ignored.Shared Var Example:
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
because it allows functional reactive observing of changes.Note that three traits must be defined for a
: 1. Shared Interface (defined as the definition of each method and shared variable):io.youi.app.YouIApplication for usage examples