setCookieHandlingRequired method

void setCookieHandlingRequired(
  1. bool cookieHandlingRequired
)

Setter method that enables/disables the cookies-are-required policy on the client side.

Enabling this policy will guarantee that cookies pertaining to the Lightstreamer Server will be sent with each request.

This holds for both cookies returned by the Server (possibly affinity cookies inserted by a Load Balancer standing in between) and for cookies set by other sites (for instance on the front-end page) and with a domain specification which includes Lightstreamer Server host. Likewise, cookies set by Lightstreamer Server and with a domain specification which includes other sites will be forwarded to them.

On the other hand enabling this setting may prevent the client from opening a streaming connection or even to connect at all depending on the browser/environment.

Default false

Lifecycle This setting should be performed before calling the LightstreamerClient.connect method. However, the value can be changed at any time: the supplied value will be used for the next HTTP request or WebSocket establishment.

Notification A change to this setting will be notified through a call to ClientListener.onPropertyChange with argument "cookieHandlingRequired" on any ClientListener.

  • cookieHandlingRequired true/false to enable/disable the cookies-are-required policy.

Implementation

external void setCookieHandlingRequired(bool cookieHandlingRequired);