lws-ws-close.h

Go to the documentation of this file.

/*
 * libwebsockets - small server side websockets and web server implementation
 *
 * Copyright (C) 2010 - 2019 Andy Green <andy@warmcat.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */

 
/*
 * NOTE: These public enums are part of the abi.  If you want to add one,
 * add it at where specified so existing users are unaffected.
 */
enum lws_close_status {
        LWS_CLOSE_STATUS_NOSTATUS                              =    0,
        LWS_CLOSE_STATUS_NORMAL                                  = 1000,
        LWS_CLOSE_STATUS_GOINGAWAY                            = 1001,
        LWS_CLOSE_STATUS_PROTOCOL_ERR                              = 1002,
        LWS_CLOSE_STATUS_UNACCEPTABLE_OPCODE                        = 1003,
        LWS_CLOSE_STATUS_RESERVED                              = 1004,
        LWS_CLOSE_STATUS_NO_STATUS                            = 1005,
        LWS_CLOSE_STATUS_ABNORMAL_CLOSE                          = 1006,
        LWS_CLOSE_STATUS_INVALID_PAYLOAD                        = 1007,
        LWS_CLOSE_STATUS_POLICY_VIOLATION                      = 1008,
        LWS_CLOSE_STATUS_MESSAGE_TOO_LARGE                    = 1009,
        LWS_CLOSE_STATUS_EXTENSION_REQUIRED                  = 1010,
        LWS_CLOSE_STATUS_UNEXPECTED_CONDITION                      = 1011,
        LWS_CLOSE_STATUS_TLS_FAILURE                                = 1015,
 
        LWS_CLOSE_STATUS_CLIENT_TRANSACTION_DONE                = 2000,
 
        /****** add new things just above ---^ ******/
 
        LWS_CLOSE_STATUS_NOSTATUS_CONTEXT_DESTROY              = 9999,
};

LWS_VISIBLE LWS_EXTERN void
lws_close_reason(struct lws *wsi, enum lws_close_status status,
                 unsigned char *buf, size_t len);