Server | Winter Cardinal

Represents a server, managing a connection to and messages from a remote server.

Hierarchy

MessageEmitter<string[]>
- Server

Implemented by

ServerImpl

Index

Constructors

constructor

Methods

Constructors

constructor

new Server(): Server

Inherited from MessageEmitter.constructor

Overrides Connectable.constructor
- Defined in src/main/typescript/wcardinal/io/message-emitter.ts:11
Returns Server

Methods

addHandler

addHandler(handler: MessageHandler<string[]>): this

Inherited from MessageEmitter.addHandler
- Defined in src/main/typescript/wcardinal/io/message-emitter.ts:18
Parameters
- handler: MessageHandler<string[]>
Returns this

ajax

ajax(mode: string, data: any, timeout: number, onSuccess: AjaxSuccessHandler, onError: AjaxErrorHandler, context?: any): void

- Defined in src/main/typescript/wcardinal/server/server.ts:82
Parameters
- mode: string
- data: any
- timeout: number
- onSuccess: AjaxSuccessHandler
- onError: AjaxErrorHandler
- Optional context: any
Returns void

connect

connect(): this

- Defined in src/main/typescript/wcardinal/server/server.ts:24
Connects to a remote server.
```
connect();
```
Returns this

this

connector

connector(): Connector

Inherited from Connectable.connector
- Defined in src/main/typescript/wcardinal/event/connectable.ts:23
Returns Connector

disconnect

disconnect(): this

- Defined in src/main/typescript/wcardinal/server/server.ts:31
Disconnects from a remote server.

Returns this

this

getProtocol

getProtocol(allowedProtocols?: PlainObject<IoSettings>): string | null

- Defined in src/main/typescript/wcardinal/server/server.ts:64
Returns the current communication protocol.
```
server.getProtocol();
```
Parameters
- Optional allowedProtocols: PlainObject<IoSettings>
  
  an array of allowed protocols
Returns string | null

The name of the current communication protocol.

getSettings

getSettings(): Settings

- Defined in src/main/typescript/wcardinal/server/server.ts:71
Returns settings.

since

1.1.0

Returns Settings

isConnected

isConnected(): boolean

- Defined in src/main/typescript/wcardinal/server/server.ts:38
Checks if a connection to a remote server is established.

Returns boolean

true if the connection is established

off

off(types: string, handler?: Function): this
off(target: unknown, types: string, handler?: Function): this

Unregister the event handlers of the specified events.

off( "success" );

// Unregister all the handlers of the events with the namespace `sample`.
off( ".sample" );

// Unregister all the handlers of the `success` event with the namespace `sample`.
off( "success.sample" );

// Multiple event types
off( "success fail" );

Parameters

types: string

space-separated event types
Optional handler: Function

the event handler to be unregistered

Returns this

this

Inherited from Connectable.off
- Defined in src/main/typescript/wcardinal/event/connectable.ts:261
Unregister the event handlers of the specified events.
```
off( "success" );

// Unregister all the handlers of the events with the namespace `sample`.
off( ".sample" );

// Unregister all the handlers of the `success` event with the namespace `sample`.
off( "success.sample" );

// Multiple event types
off( "success fail" );
```
Parameters
- target: unknown
  
  event target
- types: string
  
  space-separated event types
- Optional handler: Function
  
  the event handler to be unregistered
Returns this

this

offoff

offoff(types: string, handler?: OnoffHandler): this

Inherited from Connectable.offoff
- Defined in src/main/typescript/wcardinal/event/connectable.ts:99
Unregisters the event handler for the unregistration events of the specified events.
```
onoff("eventname", handler);
```
Parameters
- types: string
  
  space-separated event names
- Optional handler: OnoffHandler
  
  an event handler
Returns this

this

offon

offon(types: string, handler?: OnonHandler): this

Inherited from Connectable.offon
- Defined in src/main/typescript/wcardinal/event/connectable.ts:85
Unregisters the event handlers for the registration events of the specified events.
```
offon("eventname", handler);
```
Parameters
- types: string
  
  space-separated event types
- Optional handler: OnonHandler
  
  an event handler
Returns this

this

on

on(types: string, handler: Function): this
on(target: unknown, types: string, handler: Function): this

Inherited from Connectable.on
- Defined in src/main/typescript/wcardinal/event/connectable.ts:127
Registers the specified event handler for the specified events. When the handler is invoked, the this keyword is a reference to the this class. This method supports space-separated event types and namespces.
```
on( "success", function(){} );

// `success` event with a namespace `sample`
on( "success.sample", function(){} );

// Multiple namespaces
on( "success.ns1.ns2.ns3", function(){} );

// Multiple event types
on( "success fail", function(){} );

// Event target
on( eventTarget, "success", function(){} );
```
Parameters
- types: string
  
  space-separated event types
- handler: Function
  
  the event handler to be registered
Returns this

this
Inherited from Connectable.on
- Defined in src/main/typescript/wcardinal/event/connectable.ts:153
Registers the specified event handler for the specified events. When the handler is invoked, the this keyword is a reference to the this class. This method supports space-separated event types and namespces.
```
on( "success", function(){} );

// `success` event with a namespace `sample`
on( "success.sample", function(){} );

// Multiple namespaces
on( "success.ns1.ns2.ns3", function(){} );

// Multiple event types
on( "success fail", function(){} );

// Event target
on( eventTarget, "success", function(){} );
```
Parameters
- target: unknown
  
  event target or event types
- types: string
  
  space-separated event types
- handler: Function
  
  the event handler to be registered
Returns this

this

one

one(types: string, handler: Function): this
one(target: unknown, types: string, handler: Function): this

Inherited from Connectable.one
- Defined in src/main/typescript/wcardinal/event/connectable.ts:186
Registers the specified event handler for the specified events. The specified event handler is invoked at most once. When the handler is invoked, the this keyword is a reference to the this class. This method supports space-separated event types and namespces.
```
one( "success", function(){} );

// `success` event with a namespace `sample`
one( "success.sample", function(){} );

// Multiple namespaces
one( "success.ns1.ns2.ns3", function(){} );

// Multiple event types
one( "success fail", function(){} );
```
Parameters
- types: string
  
  space-separated event types
- handler: Function
  
  The event handler to be registered
Returns this

this
Inherited from Connectable.one
- Defined in src/main/typescript/wcardinal/event/connectable.ts:210
Registers the specified event handler for the specified events. The specified event handler is invoked at most once. When the handler is invoked, the this keyword is a reference to the this class. This method supports space-separated event types and namespces.
```
one( "success", function(){} );

// `success` event with a namespace `sample`
one( "success.sample", function(){} );

// Multiple namespaces
one( "success.ns1.ns2.ns3", function(){} );

// Multiple event types
one( "success fail", function(){} );
```
Parameters
- target: unknown
  
  event target
- types: string
  
  space-separated event types
- handler: Function
  
  The event handler to be registered
Returns this

this

onoff

onoff(types: string, handler: OnoffHandler): this

Inherited from Connectable.onoff
- Defined in src/main/typescript/wcardinal/event/connectable.ts:71
Registers the event handler for the unregistration events of the specified events. The handler is invoked with Connection and a boolean when the event handlers of the specified events are unregistered. The latter boolean gets true if this is the last handler of the event identified by Connection.type.
```
onoff("eventname", function( connection, isLast ){
    // DO SOMETHING HERE
});
```
Parameters
- types: string
  
  space-separated event names
- handler: OnoffHandler
  
  an event handler
Returns this

this

onon

onon(types: string, handler: OnonHandler): this

Inherited from Connectable.onon
- Defined in src/main/typescript/wcardinal/event/connectable.ts:51
Registers the event handler for the registration events of the specified events. The handler is invoked with Connection and a boolean when the event handlers of the specified events are registered. The latter boolean gets true if this is the first handler of the event identified by Connection.type.
```
onon("eventname", function( connection, isFirst ){
    if( some-condition ) {
        connection.trigger( this, null, [ first-event-parameter, second-event-parameter, ... ] );
    }
});
```
Parameters
- types: string
  
  space-separated event types
- handler: OnonHandler
  
  an event handler
Returns this

this

removeHandler

removeHandler(handler: MessageHandler<string[]>): this

Inherited from MessageEmitter.removeHandler
- Defined in src/main/typescript/wcardinal/io/message-emitter.ts:23
Parameters
- handler: MessageHandler<string[]>
Returns this

retrigger

retrigger(originalEvent: OriginalEvent, types: string, parameters?: unknown[]): unknown[]
retrigger(target: Node | null, originalEvent: OriginalEvent, types: string, parameters?: unknown[]): unknown[]

Inherited from Connectable.retrigger
- Defined in src/main/typescript/wcardinal/event/connectable.ts:380
Invokes all the handlers of the specified event.
```
retrigger( originalEvent, "success" );

// With two parameters true and 156
retrigger( originalEvent, "success", [true, 156] );

// Namespaced event type
retrigger( originalEvent, "success.sample" );

// Multiple event types
retrigger( originalEvent, "success fail" );
```
Parameters
- originalEvent: OriginalEvent
  
  the event object
- types: string
  
  space-separated event types
- Optional parameters: unknown[]
Returns unknown[]

the returned values of the invoked handlers
Inherited from Connectable.retrigger
- Defined in src/main/typescript/wcardinal/event/connectable.ts:404
Invokes all the handlers of the specified event.
```
retrigger( originalEvent, "success" );

// With two parameters true and 156
retrigger( originalEvent, "success", [true, 156] );

// Namespaced event type
retrigger( originalEvent, "success.sample" );

// Multiple event types
retrigger( originalEvent, "success fail" );
```
Parameters
- target: Node | null
  
  event target
- originalEvent: OriginalEvent
  
  the event object
- types: string
  
  space-separated event types
- Optional parameters: unknown[]
  
  event parameters
Returns unknown[]

the returned values of the invoked handlers

send

send(type: string, content: any): this

- Defined in src/main/typescript/wcardinal/server/server.ts:80
Sends a message to a remote server.

Parameters
- type: string
  
  a message type
- content: any
  
  a message content
Returns this

this

setProtocol

setProtocol(protocol: string): this

- Defined in src/main/typescript/wcardinal/server/server.ts:54
Sets a communication protocol for a remote server. The following string is allowed:
- polling: Long-polling based communication protocol
- websocket: WebSocket communication protocol
Must be called before wcardinal.server.Server#connect.
```
server.setProtocol("websocket");
```
Parameters
- protocol: string
  
  The communication protocol name.
Returns this

this

trigger

trigger(types: string, parameters?: unknown[]): unknown[]
trigger(target: Node | null, types: string, parameters?: unknown[]): unknown[]

Inherited from Connectable.trigger
- Defined in src/main/typescript/wcardinal/event/connectable.ts:298
Invokes all the handlers of the specified event.
```
trigger( "success" );

// With two parameters true and 156
trigger( "success", [true, 156] );

// Namespaced event type
trigger( "success.sample" );

// Multiple event types
trigger( "success fail" );
```
Parameters
- types: string
  
  space-separated event types
- Optional parameters: unknown[]
  
  event parameters
Returns unknown[]

the returned values of the invoked handlers
Inherited from Connectable.trigger
- Defined in src/main/typescript/wcardinal/event/connectable.ts:319
Invokes all the handlers of the specified event.
```
trigger( "success" );

// With two parameters true and 156
trigger( "success", [true, 156] );

// Namespaced event type
trigger( "success.sample" );

// Multiple event types
trigger( "success fail" );
```
Parameters
- target: Node | null
  
  Event target
- types: string
  
  space-separated event types
- Optional parameters: unknown[]
  
  event parameters
Returns unknown[]

the returned values of the invoked handlers

triggerDirect

triggerDirect(name: string, type: string[] | null, args: unknown[] | null, results: null): null
triggerDirect(name: string, type: string[] | null, args: unknown[] | null, results: unknown[]): unknown[]

Inherited from Connectable.triggerDirect
- Defined in src/main/typescript/wcardinal/event/connectable.ts:349
Parameters
- name: string
- type: string[] | null
- args: unknown[] | null
- results: null
Returns null
Inherited from Connectable.triggerDirect
- Defined in src/main/typescript/wcardinal/event/connectable.ts:352
Parameters
- name: string
- type: string[] | null
- args: unknown[] | null
- results: unknown[]
Returns unknown[]

triggerHandlers

triggerHandlers(message: string[]): this

Inherited from MessageEmitter.triggerHandlers
- Defined in src/main/typescript/wcardinal/io/message-emitter.ts:32
Parameters
- message: string[]
Returns this

Static extend

extend<T>(target: T): T & Connectable

Inherited from Connectable.extend
- Defined in src/main/typescript/wcardinal/event/connectable.ts:450
Extends the specified target with the Connectable methods.

Type parameters
- T
Parameters
- target: T
  
  non-null target to be extended
Returns T & Connectable

the specified target

Hierarchy

Implemented by

Index

Constructors

Methods

Constructors

constructor

Returns Server

Methods

addHandler

Parameters

handler: MessageHandler<string[]>

Returns this

ajax

Parameters

mode: string

data: any

timeout: number

onSuccess: AjaxSuccessHandler

onError: AjaxErrorHandler

Optional context: any

Returns void

connect

Returns this

connector

Returns Connector

disconnect

Returns this

getProtocol

Parameters

Optional allowedProtocols: PlainObject<IoSettings>

Returns string | null

getSettings

Returns Settings

isConnected

Returns boolean

off

Parameters

types: string

Optional handler: Function

Returns this

Parameters

target: unknown

types: string

Optional handler: Function

Returns this

offoff

Parameters

types: string

Optional handler: OnoffHandler

Returns this

offon

Parameters

types: string

Optional handler: OnonHandler

Returns this

on

Parameters

types: string

handler: Function

Returns this

Parameters

target: unknown

types: string

handler: Function

Returns this

one

Parameters

types: string

handler: Function

Returns this

Parameters

target: unknown

types: string

handler: Function

Returns this

onoff

Parameters

types: string

handler: OnoffHandler