/** * Copyright (C) 2009 Scalable Solutions. */ package se.scalablesolutions.akka.kernel.nio import java.net.InetSocketAddress import java.util.concurrent.{Executors, ConcurrentMap, ConcurrentHashMap} import kernel.nio.protobuf.RemoteProtocol.{RemoteRequest, RemoteReply} import kernel.actor.{Exit, Actor} import kernel.reactor.{DefaultCompletableFutureResult, CompletableFutureResult} import kernel.util.{Serializer, ScalaJSONSerializer, JavaJSONSerializer, Logging} import org.jboss.netty.bootstrap.ClientBootstrap import org.jboss.netty.channel._ import org.jboss.netty.channel.socket.nio.NioClientSocketChannelFactory import org.jboss.netty.handler.codec.frame.{LengthFieldBasedFrameDecoder, LengthFieldPrepender} import org.jboss.netty.handler.codec.protobuf.{ProtobufDecoder, ProtobufEncoder} import protobuf.RemoteProtocol import scala.collection.mutable.HashMap object RemoteClient extends Logging { private val clients = new HashMap[String, RemoteClient] def clientFor(address: InetSocketAddress): RemoteClient = synchronized { val hostname = address.getHostName val port = address.getPort val hash = hostname + ":" + port if (clients.contains(hash)) clients(hash) else { val client = new RemoteClient(hostname, port) client.connect clients += hash -> client client } } } class RemoteClient(hostname: String, port: Int) extends Logging { @volatile private var isRunning = false private val futures = new ConcurrentHashMap[Long, CompletableFutureResult] private val supervisors = new ConcurrentHashMap[String, Actor] // TODO is this Netty channelFactory and other options always the best or should it be configurable? private val channelFactory = new NioClientSocketChannelFactory( Executors.newCachedThreadPool, Executors.newCachedThreadPool) private val bootstrap = new ClientBootstrap(channelFactory) bootstrap.setPipelineFactory(new RemoteClientPipelineFactory(futures, supervisors)) bootstrap.setOption("tcpNoDelay", true) bootstrap.setOption("keepAlive", true) private var connection: ChannelFuture = _ def connect = synchronized { if (!isRunning) { connection = bootstrap.connect(new InetSocketAddress(hostname, port)) log.info("Starting remote client connection to [%s:%s]", hostname, port) // Wait until the connection attempt succeeds or fails. connection.awaitUninterruptibly if (!connection.isSuccess) { log.error("Remote connection to [%s:%s] has failed due to [%s]", hostname, port, connection.getCause) connection.getCause.printStackTrace } isRunning = true } } def shutdown = synchronized { if (!isRunning) { connection.getChannel.getCloseFuture.awaitUninterruptibly channelFactory.releaseExternalResources } } def send(request: RemoteRequest): Option[CompletableFutureResult] = if (isRunning) { if (request.getIsOneWay) { connection.getChannel.write(request) None } else { futures.synchronized { val futureResult = new DefaultCompletableFutureResult(request.getTimeout) futures.put(request.getId, futureResult) connection.getChannel.write(request) Some(futureResult) } } } else throw new IllegalStateException("Remote client is not running, make sure you have invoked 'RemoteClient.connect' before using it.") def registerSupervisorForActor(actor: Actor) = if (!actor.supervisor.isDefined) throw new IllegalStateException("Can't register supervisor for " + actor + " since it is not under supervision") else supervisors.putIfAbsent(actor.supervisor.get.uuid, actor) def deregisterSupervisorForActor(actor: Actor) = if (!actor.supervisor.isDefined) throw new IllegalStateException("Can't unregister supervisor for " + actor + " since it is not under supervision") else supervisors.remove(actor.supervisor.get.uuid) def deregisterSupervisorWithUuid(uuid: String) = supervisors.remove(uuid) } class RemoteClientPipelineFactory(futures: ConcurrentMap[Long, CompletableFutureResult], supervisors: ConcurrentMap[String, Actor]) extends ChannelPipelineFactory { def getPipeline: ChannelPipeline = { val p = Channels.pipeline() p.addLast("frameDecoder", new LengthFieldBasedFrameDecoder(1048576, 0, 4, 0, 4)); p.addLast("protobufDecoder", new ProtobufDecoder(RemoteProtocol.RemoteReply.getDefaultInstance)); p.addLast("frameEncoder", new LengthFieldPrepender(4)); p.addLast("protobufEncoder", new ProtobufEncoder()); p.addLast("handler", new RemoteClientHandler(futures, supervisors)) p } } @ChannelPipelineCoverage { val value = "all" } class RemoteClientHandler(val futures: ConcurrentMap[Long, CompletableFutureResult], val supervisors: ConcurrentMap[String, Actor]) extends SimpleChannelUpstreamHandler with Logging { override def handleUpstream(ctx: ChannelHandlerContext, event: ChannelEvent) = { if (event.isInstanceOf[ChannelStateEvent] && event.asInstanceOf[ChannelStateEvent].getState != ChannelState.INTEREST_OPS) { log.debug(event.toString) } super.handleUpstream(ctx, event) } override def messageReceived(ctx: ChannelHandlerContext, event: MessageEvent) { try { val result = event.getMessage if (result.isInstanceOf[RemoteReply]) { val reply = result.asInstanceOf[RemoteReply] log.debug("Received RemoteReply[\n%s]", reply.toString) val future = futures.get(reply.getId) if (reply.getIsSuccessful) { val messageBytes = reply.getMessage.toByteArray val messageType = reply.getMessageType val messageClass = Class.forName(messageType) val message = if (reply.isActor) ScalaJSONSerializer.in(messageBytes, Some(messageClass)) else JavaJSONSerializer.in(messageBytes, Some(messageClass)) future.completeWithResult(message) } else { if (reply.hasSupervisorUuid) { val supervisorUuid = reply.getSupervisorUuid if (!supervisors.containsKey(supervisorUuid)) throw new IllegalStateException("Expected a registered supervisor for UUID [" + supervisorUuid + "] but none was found") val supervisedActor = supervisors.get(supervisorUuid) if (!supervisedActor.supervisor.isDefined) throw new IllegalStateException("Can't handle restart for remote actor " + supervisedActor + " since its supervisor has been removed") else supervisedActor.supervisor.get ! Exit(supervisedActor, new RuntimeException(reply.getException)) } val exception = reply.getException val exceptionType = Class.forName(exception.substring(0, exception.indexOf('$'))) val exceptionMessage = exception.substring(exception.indexOf('$') + 1, exception.length) val exceptionInstance = exceptionType .getConstructor(Array[Class[_]](classOf[String]): _*) .newInstance(exceptionMessage).asInstanceOf[Throwable] future.completeWithException(null, exceptionInstance) } futures.remove(reply.getId) } else throw new IllegalArgumentException("Unknown message received in remote client handler: " + result) } catch { case e: Exception => log.error("Unexpected exception in remote client handler: %s", e) throw e } } override def exceptionCaught(ctx: ChannelHandlerContext, event: ExceptionEvent) { log.error("Unexpected exception from downstream in remote client: %s", event.getCause) event.getCause.printStackTrace event.getChannel.close } }