webecho.dependencies.websocketsbot.WebSocketsBot.scala Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2020-2022 David Crosson
 *
 * 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 webecho.dependencies.websocketsbot

import webecho.model.{EchoWebSocket, OperationOrigin}

import java.util.UUID
import scala.concurrent.Future

trait WebSocketsBot {
  def webSocketAdd(entryUUID: UUID, uri: String, userData: Option[String], origin: Option[OperationOrigin]): Future[EchoWebSocket]

  def webSocketGet(entryUUID: UUID, uuid: UUID): Future[Option[EchoWebSocket]]

  def webSocketDelete(entryUUID: UUID, uuid: UUID): Future[Option[Boolean]]

  def webSocketList(entryUUID: UUID): Future[Option[Iterable[EchoWebSocket]]]

  def webSocketAlive(entryUUID: UUID, uuid: UUID): Future[Option[Boolean]]
}