[API](/solutions/geotoolkit/geotoolkit_js/apis/readme) / [geotoolkit](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit) / [map](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.map) / [sources](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.map#sources) / [connectors](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.map#connectors) / [WebSocket](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.map#websocket) / WebSocket

# Class: WebSocket

[connectors](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.map#connectors).[WebSocket](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.map#websocket).WebSocket

Source connector that sends requests by creating WebSocket

## Hierarchy

- [`AbstractConnector`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.abstractconnector.abstractconnector)<`InstanceType`<typeof `$window.WebSocket`&gt;&gt;
↳ **`WebSocket`**


## Table of contents

Constructors
- [new WebSocket()](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.map.sources.connectors.websocket.websocket.md#new websocket())


Methods
| [abort](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.websocket.websocket#abort) | [abortConnection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.websocket.websocket#abortconnection) | [addConnection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.websocket.websocket#addconnection) |
|  --- | --- | --- |
| [clone](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.websocket.websocket#clone) | [getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.websocket.websocket#getclassname) | [getConnection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.websocket.websocket#getconnection) |
| [isLoading](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.websocket.websocket#isloading) | [isValidUrl](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.websocket.websocket#isvalidurl) | [removeConnection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.websocket.websocket#removeconnection) |
| [send](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.websocket.websocket#send) | [getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.websocket.websocket#getclassname-1) |


## Contents

Constructors
#### new WebSocket()

• **new WebSocket**()

#### Overrides

AbstractConnector&lt;InstanceType&lt;typeof $window.WebSocket&amp;gt;&amp;gt;.constructor

Methods
#### abort

▸ **abort**(`key?`): [`WebSocket`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.websocket.websocket)

Aborts the previous queries sent

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `Optional` `key` | `string` | key of the queries to abort (all queries aborted if nothing provided) |


#### Returns

[`WebSocket`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.websocket.websocket)

this

#### Inherited from

[AbstractConnector](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.abstractconnector.abstractconnector).[abort](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.abstractconnector.abstractconnector#abort)

#### abortConnection

▸ `Protected` **abortConnection**(`connection`): [`WebSocket`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.websocket.websocket)

Aborts the connection provided

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `connection` | `WebSocket` | connection to abort |


#### Returns

[`WebSocket`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.websocket.websocket)

this

#### Overrides

[AbstractConnector](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.abstractconnector.abstractconnector).[abortConnection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.abstractconnector.abstractconnector#abortconnection)

#### addConnection

▸ `Protected` **addConnection**(`key`, `connection`): [`WebSocket`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.websocket.websocket)

Adds connection to the list

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `key` | `string` | key of the connection (null if no provided) |
| `connection` | `WebSocket` | connection to add to the list |


#### Returns

[`WebSocket`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.websocket.websocket)

this

#### Inherited from

[AbstractConnector](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.abstractconnector.abstractconnector).[addConnection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.abstractconnector.abstractconnector#addconnection)

#### clone

▸ **clone**(): [`AbstractConnector`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.abstractconnector.abstractconnector)<`WebSocket`&gt;

All subclasses should override copyConstructor or provide custom implementation for this method

#### Returns

[`AbstractConnector`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.abstractconnector.abstractconnector)<`WebSocket`&gt;

clone

#### Inherited from

[AbstractConnector](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.abstractconnector.abstractconnector).[clone](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.abstractconnector.abstractconnector#clone)

#### getClassName

▸ **getClassName**(): `string`

#### Returns

`string`

#### Inherited from

[AbstractConnector](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.abstractconnector.abstractconnector).[getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.abstractconnector.abstractconnector#getclassname)

#### getConnection

▸ `Protected` **getConnection**(`key`): `WebSocket`

Returns connection by the key

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `key` | `string` | key for the connection |


#### Returns

`WebSocket`

connection

#### Inherited from

[AbstractConnector](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.abstractconnector.abstractconnector).[getConnection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.abstractconnector.abstractconnector#getconnection)

#### isLoading

▸ **isLoading**(): `boolean`

Checks if some connections are still loading

#### Returns

`boolean`

#### Inherited from

[AbstractConnector](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.abstractconnector.abstractconnector).[isLoading](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.abstractconnector.abstractconnector#isloading)

#### isValidUrl

▸ **isValidUrl**(`url`): `boolean`

Check if URL is configured to load layer data

#### Parameters

| Name  | Type  |
|  --- | --- |
| `url` | `string` | `string`[] |


#### Returns

`boolean`

#### Inherited from

[AbstractConnector](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.abstractconnector.abstractconnector).[isValidUrl](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.abstractconnector.abstractconnector#isvalidurl)

#### removeConnection

▸ `Protected` **removeConnection**(`key`, `connection`): [`WebSocket`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.websocket.websocket)

Removes connection from the list

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `key` | `string` | key of the connection (null if no provided) |
| `connection` | `WebSocket` | connection to remvoe from the list |


#### Returns

[`WebSocket`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.websocket.websocket)

this

#### Inherited from

[AbstractConnector](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.abstractconnector.abstractconnector).[removeConnection](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.abstractconnector.abstractconnector#removeconnection)

#### send

▸ **send**(`url`, `options`, `callback`): `void`

Sends a request using the query provided

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `url` | `string` | the url requested |
| `options` | [`SendOptions`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.map#abstractconnector#sendoptions) | extra options for the request (null if no needed) |
| `callback` | [`SendCallback`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.map#abstractconnector#sendcallback) | the result handler that's called when response is received |


#### Returns

`void`

#### Overrides

[AbstractConnector](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.abstractconnector.abstractconnector).[send](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.abstractconnector.abstractconnector#send)

#### getClassName

▸ `Static` **getClassName**(): `string`

#### Returns

`string`

#### Inherited from

[AbstractConnector](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.abstractconnector.abstractconnector).[getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.map.sources.connectors.abstractconnector.abstractconnector#getclassname-1)