Overview   Project   Class   Tree   Index 
CEF3 C++ API Docs - Version 75.1.4+g4210896+chromium-75.0.3770.100
FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD

(default)
Class CefServer

CefBaseRefCounted
   |
   +--CefServer

   in cef_server.h

class CefServer
extends CefBaseRefCounted

Class representing a server that supports HTTP and WebSocket requests. Server capacity is limited and is intended to handle only a small number of simultaneous connections (e.g. for communicating between applications on localhost). The methods of this class are safe to call from any thread in the brower process unless otherwise indicated.


Inner Classes, Typedefs, and Enums
typedef CefServer::HeaderMap
          
 
Method Summary
 virtual void CloseConnection( int connection_id )= 0
          Close the connection identified by |connection_id|.
 static void CreateServer( const CefString& address, uint16 port, int backlog, CefRefPtr< CefServerHandler > handler )
          Create a new server that binds to |address| and |port|.
 virtual CefString GetAddress()= 0
          Returns the server address including the port number.
 virtual CefRefPtr< CefTaskRunner > GetTaskRunner()= 0
          Returns the task runner for the dedicated server thread.
 virtual bool HasConnection()= 0
          Returns true if the server currently has a connection.
 virtual bool IsRunning()= 0
          Returns true if the server is currently running and accepting incoming connections.
 virtual bool IsValidConnection( int connection_id )= 0
          Returns true if |connection_id| represents a valid connection.
 virtual void SendHttp200Response( int connection_id, const CefString& content_type, const void* data, size_t data_size )= 0
          Send an HTTP 200 "OK" response to the connection identified by |connection_id|.
 virtual void SendHttp404Response( int connection_id )= 0
          Send an HTTP 404 "Not Found" response to the connection identified by |connection_id|.
 virtual void SendHttp500Response( int connection_id, const CefString& error_message )= 0
          Send an HTTP 500 "Internal Server Error" response to the connection identified by |connection_id|.
 virtual void SendHttpResponse( int connection_id, int response_code, const CefString& content_type, int64 content_length, const CefServer::HeaderMap& extra_headers )= 0
          Send a custom HTTP response to the connection identified by |connection_id|.
 virtual void SendRawData( int connection_id, const void* data, size_t data_size )= 0
          Send raw data directly to the connection identified by |connection_id|.
 virtual void SendWebSocketMessage( int connection_id, const void* data, size_t data_size )= 0
          Send a WebSocket message to the connection identified by |connection_id|.
 virtual void Shutdown()= 0
          Stop the server and shut down the dedicated server thread.
   
Methods inherited from class CefBaseRefCounted
AddRef, Release, HasOneRef, HasAtLeastOneRef
 

Method Detail

CloseConnection

public virtual void CloseConnection( int connection_id )= 0;
Close the connection identified by |connection_id|. See SendHttpResponse documentation for intended usage.

CreateServer

public static void CreateServer( const CefString& address, uint16 port, int backlog, CefRefPtr< CefServerHandler > handler );
Create a new server that binds to |address| and |port|. |address| must be a valid IPv4 or IPv6 address (e.g. 127.0.0.1 or ::1) and |port| must be a port number outside of the reserved range (e.g. between 1025 and 65535 on most platforms). |backlog| is the maximum number of pending connections. A new thread will be created for each CreateServer call (the "dedicated server thread"). It is therefore recommended to use a different CefServerHandler instance for each CreateServer call to avoid thread safety issues in the CefServerHandler implementation. The CefServerHandler::OnServerCreated method will be called on the dedicated server thread to report success or failure. See CefServerHandler::OnServerCreated documentation for a description of server lifespan.

GetAddress

public virtual CefString GetAddress()= 0;
Returns the server address including the port number.

GetTaskRunner

public virtual CefRefPtr< CefTaskRunner > GetTaskRunner()= 0;
Returns the task runner for the dedicated server thread.

HasConnection

public virtual bool HasConnection()= 0;
Returns true if the server currently has a connection. This method must be called on the dedicated server thread.

IsRunning

public virtual bool IsRunning()= 0;
Returns true if the server is currently running and accepting incoming connections. See CefServerHandler::OnServerCreated documentation for a description of server lifespan. This method must be called on the dedicated server thread.

IsValidConnection

public virtual bool IsValidConnection( int connection_id )= 0;
Returns true if |connection_id| represents a valid connection. This method must be called on the dedicated server thread.

SendHttp200Response

public virtual void SendHttp200Response( int connection_id, const CefString& content_type, const void* data, size_t data_size )= 0;
Send an HTTP 200 "OK" response to the connection identified by |connection_id|. |content_type| is the response content type (e.g. "text/html"), |data| is the response content, and |data_size| is the size of |data| in bytes. The contents of |data| will be copied. The connection will be closed automatically after the response is sent.

SendHttp404Response

public virtual void SendHttp404Response( int connection_id )= 0;
Send an HTTP 404 "Not Found" response to the connection identified by |connection_id|. The connection will be closed automatically after the response is sent.

SendHttp500Response

public virtual void SendHttp500Response( int connection_id, const CefString& error_message )= 0;
Send an HTTP 500 "Internal Server Error" response to the connection identified by |connection_id|. |error_message| is the associated error message. The connection will be closed automatically after the response is sent.

SendHttpResponse

public virtual void SendHttpResponse( int connection_id, int response_code, const CefString& content_type, int64 content_length, const CefServer::HeaderMap& extra_headers )= 0;
Send a custom HTTP response to the connection identified by |connection_id|. |response_code| is the HTTP response code sent in the status line (e.g. 200), |content_type| is the response content type sent as the "Content-Type" header (e.g. "text/html"), |content_length| is the expected content length, and |extra_headers| is the map of extra response headers. If |content_length| is >= 0 then the "Content-Length" header will be sent. If |content_length| is 0 then no content is expected and the connection will be closed automatically after the response is sent. If |content_length| is < 0 then no "Content-Length" header will be sent and the client will continue reading until the connection is closed. Use the SendRawData method to send the content, if applicable, and call CloseConnection after all content has been sent.

SendRawData

public virtual void SendRawData( int connection_id, const void* data, size_t data_size )= 0;
Send raw data directly to the connection identified by |connection_id|. |data| is the raw data and |data_size| is the size of |data| in bytes. The contents of |data| will be copied. No validation of |data| is performed internally so the client should be careful to send the amount indicated by the "Content-Length" header, if specified. See SendHttpResponse documentation for intended usage.

SendWebSocketMessage

public virtual void SendWebSocketMessage( int connection_id, const void* data, size_t data_size )= 0;
Send a WebSocket message to the connection identified by |connection_id|. |data| is the response content and |data_size| is the size of |data| in bytes. The contents of |data| will be copied. See CefServerHandler::OnWebSocketRequest documentation for intended usage.

Shutdown

public virtual void Shutdown()= 0;
Stop the server and shut down the dedicated server thread. See CefServerHandler::OnServerCreated documentation for a description of server lifespan.

 Overview   Project   Class   Tree   Index 
CEF3 C++ API Docs - Version 75.1.4+g4210896+chromium-75.0.3770.100
FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD

Chromium Embedded Framework (CEF) Copyright © 2016 Marshall A. Greenblatt