Skip to content

Commit

Permalink
fixed spelling, including "experimental" in API
Browse files Browse the repository at this point in the history
  • Loading branch information
breyed committed Jun 8, 2013
1 parent 2e2a8e4 commit 808a8ce
Show file tree
Hide file tree
Showing 40 changed files with 76 additions and 76 deletions.
2 changes: 1 addition & 1 deletion SConstruct
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ env.Append(CPPPATH = ['#'])

##### Set up C++11 environment
polyfill_libs = [] # boost libraries used as drop in replacements for incomplete
# C++11 STL implimentations
# C++11 STL implementations
env_cpp11 = env.Clone ()

if env_cpp11['CXX'].startswith('g++'):
Expand Down
2 changes: 1 addition & 1 deletion examples/associative_storage/associative_storage.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ class print_server {
if (it == m_connections.end()) {
// this connection is not in the list. This really shouldn't happen
// and probably means something else is wrong.
throw std::invalid_argument("No data avaliable for session");
throw std::invalid_argument("No data available for session");
}

return it->second;
Expand Down
2 changes: 1 addition & 1 deletion examples/broadcast_server/SConscript
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ env_cpp11 = env_cpp11.Clone ()

prgs = []

# if a C++11 environment is avaliable build using that, otherwise use boost
# if a C++11 environment is available build using that, otherwise use boost
if env_cpp11.has_key('WSPP_CPP11_ENABLED'):
ALL_LIBS = boostlibs(['system'],env_cpp11) + [platform_libs] + [polyfill_libs]
prgs += env_cpp11.Program('broadcast_server', ["broadcast_server.cpp"], LIBS = ALL_LIBS)
Expand Down
2 changes: 1 addition & 1 deletion examples/echo_client/SConscript
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ env_cpp11 = env_cpp11.Clone ()

prgs = []

# if a C++11 environment is avaliable build using that, otherwise use boost
# if a C++11 environment is available build using that, otherwise use boost
if env_cpp11.has_key('WSPP_CPP11_ENABLED'):
ALL_LIBS = boostlibs(['system'],env_cpp11) + [platform_libs] + [polyfill_libs]
prgs += env_cpp11.Program('echo_client', ["echo_client.cpp"], LIBS = ALL_LIBS)
Expand Down
2 changes: 1 addition & 1 deletion examples/echo_server/SConscript
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ env_cpp11 = env_cpp11.Clone ()

prgs = []

# if a C++11 environment is avaliable build using that, otherwise use boost
# if a C++11 environment is available build using that, otherwise use boost
if env_cpp11.has_key('WSPP_CPP11_ENABLED'):
ALL_LIBS = boostlibs(['system'],env_cpp11) + [platform_libs] + [polyfill_libs]
prgs += env_cpp11.Program('echo_server', ["echo_server.cpp"], LIBS = ALL_LIBS)
Expand Down
2 changes: 1 addition & 1 deletion examples/echo_server_tls/SConscript
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ env_cpp11 = env_cpp11.Clone ()

prgs = []

# if a C++11 environment is avaliable build using that, otherwise use boost
# if a C++11 environment is available build using that, otherwise use boost
if env_cpp11.has_key('WSPP_CPP11_ENABLED'):
ALL_LIBS = boostlibs(['system'],env_cpp11) + [platform_libs] + [polyfill_libs] + [tls_libs]
prgs += env_cpp11.Program('echo_server_tls', ["echo_server_tls.cpp"], LIBS = ALL_LIBS)
Expand Down
2 changes: 1 addition & 1 deletion examples/iostream_server/SConscript
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ env_cpp11 = env_cpp11.Clone ()

prgs = []

# if a C++11 environment is avaliable build using that, otherwise use boost
# if a C++11 environment is available build using that, otherwise use boost
if env_cpp11.has_key('WSPP_CPP11_ENABLED'):
ALL_LIBS = boostlibs(['system'],env_cpp11) + [platform_libs] + [polyfill_libs]
prgs += env_cpp11.Program('iostream_server', ["iostream_server.cpp"], LIBS = ALL_LIBS)
Expand Down
2 changes: 1 addition & 1 deletion examples/print_server/SConscript
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ env_cpp11 = env_cpp11.Clone ()

prgs = []

# if a C++11 environment is avaliable build using that, otherwise use boost
# if a C++11 environment is available build using that, otherwise use boost
if env_cpp11.has_key('WSPP_CPP11_ENABLED'):
ALL_LIBS = boostlibs(['system'],env_cpp11) + [platform_libs] + [polyfill_libs]
prgs += env_cpp11.Program('print_server', ["print_server.cpp"], LIBS = ALL_LIBS)
Expand Down
2 changes: 1 addition & 1 deletion examples/subprotocol_server/SConscript
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ env_cpp11 = env_cpp11.Clone ()

prgs = []

# if a C++11 environment is avaliable build using that, otherwise use boost
# if a C++11 environment is available build using that, otherwise use boost
if env_cpp11.has_key('WSPP_CPP11_ENABLED'):
ALL_LIBS = boostlibs(['system'],env_cpp11) + [platform_libs] + [polyfill_libs]
prgs += env_cpp11.Program('subprotocol_server', ["subprotocol_server.cpp"], LIBS = ALL_LIBS)
Expand Down
2 changes: 1 addition & 1 deletion examples/telemetry_client/SConscript
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ env_cpp11 = env_cpp11.Clone ()

prgs = []

# if a C++11 environment is avaliable build using that, otherwise use boost
# if a C++11 environment is available build using that, otherwise use boost
if env_cpp11.has_key('WSPP_CPP11_ENABLED'):
ALL_LIBS = boostlibs(['system'],env_cpp11) + [platform_libs] + [polyfill_libs]
prgs += env_cpp11.Program('telemetry_client', ["telemetry_client.cpp"], LIBS = ALL_LIBS)
Expand Down
2 changes: 1 addition & 1 deletion examples/testee_server/SConscript
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ env_cpp11 = env_cpp11.Clone ()

prgs = []

# if a C++11 environment is avaliable build using that, otherwise use boost
# if a C++11 environment is available build using that, otherwise use boost
if env_cpp11.has_key('WSPP_CPP11_ENABLED'):
ALL_LIBS = boostlibs(['system'],env_cpp11) + [platform_libs] + [polyfill_libs]
prgs += env_cpp11.Program('testee_server', ["testee_server.cpp"], LIBS = ALL_LIBS)
Expand Down
2 changes: 1 addition & 1 deletion examples/utility_client/SConscript
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ env_cpp11 = env_cpp11.Clone ()

prgs = []

# if a C++11 environment is avaliable build using that, otherwise use boost
# if a C++11 environment is available build using that, otherwise use boost
if env_cpp11.has_key('WSPP_CPP11_ENABLED'):
ALL_LIBS = boostlibs(['system'],env_cpp11) + [platform_libs] + [polyfill_libs] + [tls_libs]
prgs += env_cpp11.Program('utility_client', ["utility_client.cpp"], LIBS = ALL_LIBS)
Expand Down
8 changes: 4 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
WebSocket++ (0.3.x branch)
==========================

WebSocket++ is a header only C++ library that impliments RFC6455 The WebSocket
WebSocket++ is a header only C++ library that implements RFC6455 The WebSocket
Protocol. It allows integrating WebSocket client and server functionality into
C++ programs. It uses interchangable network transport modules including one
C++ programs. It uses interchangeable network transport modules including one
based on C++ iostreams and one based on Boost Asio.

*This branch is no longer "experimental". It represents the current edge release
of the WebSocket++ library. The API of 0.3.x has some significant changes from
0.2.x, so care should be taken when upgrading.*

*This branch's API is relatively stable now. Features implimented so far are
*This branch's API is relatively stable now. Features implemented so far are
unlikely to change (except where explicitly noted). New features will be added
regularly until parity with the 0.2 branch is reached.*

Expand All @@ -25,7 +25,7 @@ Major Features
* Message/event based interface
* Supports secure WebSockets (TLS), IPv6, and explicit proxies.
* Flexible dependency management (C++11 Standard Library or Boost)
* Interchangable network transport modules (iostream and Boost Asio)
* Interchangeable network transport modules (iostream and Boost Asio)
* Portible, cross platform and architecture design

Get Involved
Expand Down
2 changes: 1 addition & 1 deletion test/roles/server.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ BOOST_AUTO_TEST_CASE( invalid_websocket_version ) {
BOOST_CHECK_EQUAL(run_server_test(s,input), output);
}

BOOST_AUTO_TEST_CASE( unimplimented_websocket_version ) {
BOOST_AUTO_TEST_CASE( unimplemented_websocket_version ) {
std::string input = "GET / HTTP/1.1\r\nHost: www.example.com\r\nConnection: upgrade\r\nUpgrade: websocket\r\nSec-WebSocket-Version: 14\r\nSec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==\r\nOrigin: http://www.example.com\r\n\r\n";

std::string output = "HTTP/1.1 400 Bad Request\r\nSec-WebSocket-Version: 0,7,8,13\r\nServer: test\r\n\r\n";
Expand Down
2 changes: 1 addition & 1 deletion websocketpp/config/core.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ struct core {
* for debugging and presenting useful errors to end users but may be
* undesirable for security reasons in some production environments.
* Close reasons could be used by an attacker to confirm that the endpoint
* is out of resources or be used to identify the WebSocket implimentation
* is out of resources or be used to identify the WebSocket implementation
* in use.
*
* Note: this will suppress *all* close codes, including those explicitly
Expand Down
2 changes: 1 addition & 1 deletion websocketpp/config/core_client.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ struct core_client {
* for debugging and presenting useful errors to end users but may be
* undesirable for security reasons in some production environments.
* Close reasons could be used by an attacker to confirm that the endpoint
* is out of resources or be used to identify the WebSocket implimentation
* is out of resources or be used to identify the WebSocket implementation
* in use.
*
* Note: this will suppress *all* close codes, including those explicitly
Expand Down
2 changes: 1 addition & 1 deletion websocketpp/config/debug.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ struct debug_core {
* for debugging and presenting useful errors to end users but may be
* undesirable for security reasons in some production environments.
* Close reasons could be used by an attacker to confirm that the endpoint
* is out of resources or be used to identify the WebSocket implimentation
* is out of resources or be used to identify the WebSocket implementation
* in use.
*
* Note: this will suppress *all* close codes, including those explicitly
Expand Down
8 changes: 4 additions & 4 deletions websocketpp/connection.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ namespace status {
GOOD = 0, // no failure yet!
SYSTEM = 1, // system call returned error, check that code
WEBSOCKET = 2, // websocket close codes contain error
UNKNOWN = 3, // No failure information is avaliable
UNKNOWN = 3, // No failure information is available
TIMEOUT_TLS = 4, // TLS handshake timed out
TIMEOUT_WS = 5 // WS handshake timed out
};
Expand All @@ -97,8 +97,8 @@ namespace status {

namespace internal_state {
// More granular internal states. These are used for multi-threaded
// connection syncronization and preventing values that are not yet or no
// longer avaliable from being used.
// connection synchronization and preventing values that are not yet or no
// longer available from being used.

enum value {
USER_INIT = 0,
Expand Down Expand Up @@ -271,7 +271,7 @@ class connection
* period. It is specified in milliseconds.
*
* This can be used to probe the health of the remote endpoint's WebSocket
* implimentation. This does not guarantee that the remote application
* implementation. This does not guarantee that the remote application
* itself is still healthy but can be a useful diagnostic.
*
* Note: receipt of this callback doesn't mean the pong will never come.
Expand Down
6 changes: 3 additions & 3 deletions websocketpp/extensions/extension.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,9 @@ namespace websocketpp {
/**
* Some generic information about extensions
*
* Each extension object has an implimented flag. It can be retrieved by calling
* is_implimented(). This compile time flag indicates whether or not the object
* in question actually impliments the extension or if it is a placeholder stub
* Each extension object has an implemented flag. It can be retrieved by calling
* is_implemented(). This compile time flag indicates whether or not the object
* in question actually implements the extension or if it is a placeholder stub
*
* Each extension object also has an enabled flag. It can be retrieved by
* calling is_enabled(). This runtime flag indicates whether or not the
Expand Down
4 changes: 2 additions & 2 deletions websocketpp/extensions/permessage_deflate/disabled.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ namespace permessage_deflate {

/// Stub class for use when disabling permessage_deflate extension
/**
* This class is a stub that impliments the permessage_deflate interface
* This class is a stub that implements the permessage_deflate interface
* with minimal dependencies. It is used to disable permessage_deflate
* functionality at compile time without loading any unnecessary code.
*/
Expand All @@ -59,7 +59,7 @@ class disabled {

/// Returns true if the extension is capable of providing
/// permessage_deflate functionality
bool is_implimented() const {
bool is_implemented() const {
return false;
}

Expand Down
8 changes: 4 additions & 4 deletions websocketpp/extensions/permessage_deflate/enabled.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -410,7 +410,7 @@ class deflate_engine {
* Template parameter econfig defines compile time types, constants, and
* settings. It should be a struct with the following members:
*
* request_type (type) A type that impliments the http::request interface
* request_type (type) A type that implements the http::request interface
*
* allow_disabling_context_takeover (static const bool) whether or not to
* disable context takeover when the other endpoint requests it.
Expand All @@ -422,7 +422,7 @@ class deflate_engine {
*
*
* Methods:
* permessage_deflate::enabled does not define or impliment any methods
* permessage_deflate::enabled does not define or implement any methods
* itself. It uses the attribute list to determine
*
*
Expand Down Expand Up @@ -533,8 +533,8 @@ class enabled {
return ret;
}

/// Returns true if this object impliments permessage_deflate functionality
bool is_implimented() const {
/// Returns true if this object implements permessage_deflate functionality
bool is_implemented() const {
return true;
}

Expand Down
2 changes: 1 addition & 1 deletion websocketpp/frame.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -773,7 +773,7 @@ inline void word_mask_exact(uint8_t* data, size_t length, const
*
* word_mask returns a copy of prepared_key circularly shifted based on the
* length value. The returned value may be fed back into word_mask when more
* data is avaliable.
* data is available.
*
* input and output must both have length at least:
* ceil(length/sizeof(size_t))*sizeof(size_t)
Expand Down
4 changes: 2 additions & 2 deletions websocketpp/http/constants.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ namespace http {
request_header_fields_too_large = 431,

internal_server_error = 500,
not_implimented = 501,
not_implemented = 501,
bad_gateway = 502,
service_unavailable = 503,
gateway_timeout = 504,
Expand Down Expand Up @@ -223,7 +223,7 @@ namespace http {
return "Request Header Fields Too Large";
case internal_server_error:
return "Internal Server Error";
case not_implimented:
case not_implemented:
return "Not Implimented";
case bad_gateway:
return "Bad Gateway";
Expand Down
2 changes: 1 addition & 1 deletion websocketpp/http/impl/response.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,7 @@ inline size_t response::process_body(const char *buf, size_t len) {
to_read = m_read;
m_state = DONE;
} else {
// we need more bytes than are avaliable, read them all
// we need more bytes than are available, read them all
to_read = len;
}

Expand Down
2 changes: 1 addition & 1 deletion websocketpp/http/request.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ class request : public parser {
* final header delimiters.
*
* Consume is a streaming processor. It may be called multiple times on one
* request and the full headers need not be avaliable before processing can
* request and the full headers need not be available before processing can
* begin. If the end of the request was reached during this call to consume
* the ready flag will be set. Further calls to consume once ready will be
* ignored.
Expand Down
2 changes: 1 addition & 1 deletion websocketpp/http/response.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ class response : public parser {
* final header delimiters.
*
* Consume is a streaming processor. It may be called multiple times on one
* response and the full headers need not be avaliable before processing can
* response and the full headers need not be available before processing can
* begin. If the end of the response was reached during this call to consume
* the ready flag will be set. Further calls to consume once ready will be
* ignored.
Expand Down
6 changes: 3 additions & 3 deletions websocketpp/impl/connection_impl.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -564,7 +564,7 @@ void connection<config>::start() {
"Start must be called from user init state"
);

// Depending on how the transport impliments init this function may return
// Depending on how the transport implements init this function may return
// immediately and call handle_transport_init later or call
// handle_transport_init from this function.
transport_con_type::init(
Expand Down Expand Up @@ -994,7 +994,7 @@ bool connection<config>::process_handshake_request() {
m_response.set_status(http::status_code::bad_request);
return false;
} else {
// extension negotiation succeded, set response header accordingly
// extension negotiation succeeded, set response header accordingly
// we don't send an empty extensions header because it breaks many
// clients.
if (neg_results.second.size() > 0) {
Expand Down Expand Up @@ -1660,7 +1660,7 @@ lib::error_code connection<config>::send_close_frame(close::status::value code,
const std::string &reason, bool ack, bool terminal)
{
m_alog.write(log::alevel::devel,"send_close_frame");
// If silent close is set, repsect it and blank out close information
// If silent close is set, respect it and blank out close information
// Otherwise use whatever has been specified in the parameters. If
// parameters specifies close::status::blank then determine what to do
// based on whether or not this is an ack. If it is not an ack just
Expand Down
4 changes: 2 additions & 2 deletions websocketpp/message_buffer/message.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ namespace message_buffer {
* requested from the manager the requester and it's associated downstream code
* may keep a pointer to the message indefinitely at a cost of extra resource
* usage. Once the reference count drops to the point where the manager is the
* only reference the messages is recycled using whatever method is implimented
* only reference the messages is recycled using whatever method is implemented
* in the manager.
*
* # endpoint_message_manager:
Expand Down Expand Up @@ -156,7 +156,7 @@ class message {
/// Get whether or not the message is terminal
/**
* Messages can be flagged as terminal, which results in the connection
* being close after they are written rather than the implimentation going
* being close after they are written rather than the implementation going
* on to the next message in the queue. This is typically used internally
* for close messages only.
*/
Expand Down
2 changes: 1 addition & 1 deletion websocketpp/message_buffer/pool.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ namespace message_buffer {
* requested from the manager the requester and it's associated downstream code
* may keep a pointer to the message indefinitely at a cost of extra resource
* usage. Once the reference count drops to the point where the manager is the
* only reference the messages is recycled using whatever method is implimented
* only reference the messages is recycled using whatever method is implemented
* in the manager.
*
* # endpoint_message_manager:
Expand Down
Loading

0 comments on commit 808a8ce

Please sign in to comment.