FxNAWebSocket.h

Go to the documentation of this file.

//
// (C) Copyright 2005-2025 by Graebert GmbH.
//
// Permission to use, copy, modify, and distribute this software in
// object code form for any purpose and without fee is hereby granted, 
// provided that the above copyright notice appears in all copies and 
// that both that copyright notice and the limited warranty and
// restricted rights notice below appear in all supporting 
// documentation.
//
// GRAEBERT PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS. 
// GRAEBERT SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
// MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE.  GRAEBERT GMBH 
// DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
// UNINTERRUPTED OR ERROR FREE.
 
#pragma once
 
#include "../FxCommonFramework.h"
#include "../UI/FxUIObject.h"
#include "../UI/FxUISignal.h"
#include "FxNANetworkRequest.h"
#include "FxNAWebSocketProtocol.h"
 
 
 
using CFxNAString = CFxUIString;

 
class COMMONUI_API CFxNAWebSocket : public CFxUIObject
{
public:
    enum SocketState
    {
        UnconnectedState,
        HostLookupState,
        ConnectingState,
        ConnectedState,
        BoundState,
        ListeningState,
        ClosingState
    };

    explicit CFxNAWebSocket( const CFxNAString &origin = CFxNAString(),
                             CFxNAWebSocketProtocol::Version version = CFxNAWebSocketProtocol::VersionLatest );

    ~CFxNAWebSocket();

    long long sendTextMessage( const CFxUIString &textMessage );
 
    // Slots

    void open( const CFxNANetworkRequest &request );

    void close( CFxNAWebSocketProtocol::CloseCode closeCode = CFxNAWebSocketProtocol::CloseCodeNormal, const CFxNAString &reason = CFxNAString() );
 
    // Signals

    CFxUISignal< void( void ) >& connected();

    CFxUISignal< void( int ) >& error();

    CFxUISignal< void( void ) >& disconnected();

    CFxUISignal< void( const CFxNAString & ) >& textMessageReceived();
 
    //...
};