io.gatling.http.request.builder.sse.Sse.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gatling-http Show documentation

gatling-http

There is a newer version: 3.13.1

/**
 * Copyright 2011-2014 eBusiness Information, Groupe Excilys (www.ebusinessinformation.fr)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * 		http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.gatling.http.request.builder.sse

import io.gatling.core.session.{ SessionPrivateAttributes, Expression }
import io.gatling.http.action.sse._
import io.gatling.http.action.ws.WsSetCheckActionBuilder
import io.gatling.http.check.ws._

object Sse {
  val DefaultSseName = SessionPrivateAttributes.PrivateAttributePrefix + "http.sse"
}

class Sse(requestName: Expression[String], sseName: String = Sse.DefaultSseName) {

  def sseName(sseName: String) = new Sse(requestName, sseName)

  /**
   * Open the sse stream and get the results of the stream
   */
  def open(url: Expression[String]) = SseOpenRequestBuilder(requestName, url, sseName)

  /**
   * Check for incoming messages on the given sse.
   *
   * @param checkBuilder The check builder
   */
  def check(checkBuilder: WsCheckBuilder) = new WsSetCheckActionBuilder(requestName, checkBuilder, sseName)

  /**
   * Cancel current check on the given sse.
   */
  def cancelCheck = new SseCancelCheckActionBuilder(requestName, sseName)

  /**
   * Reconciliate the main state with the one of the sse flow.
   */
  def reconciliate() = new SseReconciliateActionBuilder(requestName, sseName)

  /**
   * Closes the sse stream.
   */
  def close() = new SseCloseActionBuilder(requestName, sseName)
}