com.facebook.buck.httpserver

Class WebServer

java.lang.Object

com.facebook.buck.httpserver.WebServer

public class WebServer
extends Object

A WebSocket server that reports events of buck.

The WebServer can be modeled as: a) a network listener/dispatcher which sits on the port and listens for incoming http requests. b) static handlers - list of handlers that are bound to the current process (list of traces/logs/socket), c) 'normal' handlers, bound to the daemon state.

We would like the server to go down as infrequently as possible (this makes it simpler for /ws users who would otherwise need to reconnect and potentially lose state) which is the reason for section c) above.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebServer.WebServerException

Constructor Summary

Constructors

Constructor and Description
WebServer(int port, ProjectFilesystem projectFilesystem, Clock clock)

Method Summary

Modifier and Type	Method and Description
WebServerBuckEventListener	createListener()
int	getNumActiveConnections()
int	getPort()
void	stop()
void	updateAndStartIfNeeded(Optional<ArtifactCache> artifactCache) Update state and start the server if necessary.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebServer

public WebServer(int port,
                 ProjectFilesystem projectFilesystem,
                 Clock clock)

Parameters:

port - If 0, then an ephemeral port will be assigned. Use getPort() to find out which port is being used.

Method Detail

getPort

public int getPort()

Returns:

The port that web server is listening on.

createListener

public WebServerBuckEventListener createListener()

getNumActiveConnections

public int getNumActiveConnections()

Returns:

Number of clients streaming from webserver

updateAndStartIfNeeded

public void updateAndStartIfNeeded(Optional<ArtifactCache> artifactCache)
                            throws WebServer.WebServerException

Update state and start the server if necessary.

Parameters:

artifactCache - cache to serve.

Throws:

WebServer.WebServerException

stop

public void stop()
          throws WebServer.WebServerException

Throws:

WebServer.WebServerException