IHubProtocol Class Reference

Interface for SignalR hub protocol implementations. More...

#include <IHubProtocol.h>

Inheritance diagram for IHubProtocol:

Public Member Functions
virtual	~IHubProtocol ()
virtual FName	Name () const =0
	Gets the name of the protocol.
virtual int	Version () const =0
	Gets the version of the protocol.
virtual FString	SerializeMessage (const FHubMessage *) const =0
	Serializes a hub message to a string.
virtual TArray< TSharedPtr< FHubMessage > >	ParseMessages (const FString &) const =0
	Parses a string containing one or more serialized hub messages.

Detailed Description

Interface for SignalR hub protocol implementations.

Defines methods for serializing and parsing SignalR messages.

Constructor & Destructor Documentation

~IHubProtocol()

IHubProtocol::~IHubProtocol ( )

virtual

Member Function Documentation

Name()

virtual FName IHubProtocol::Name ( ) const

pure virtual

Gets the name of the protocol.

Returns

The name of the protocol.

Implemented in FJsonHubProtocol.

ParseMessages()

virtual TArray< TSharedPtr< FHubMessage > > IHubProtocol::ParseMessages ( const FString & ) const

pure virtual

Parses a string containing one or more serialized hub messages.

Parameters

Message

The string to parse.

Returns

An array of parsed hub messages.

Implemented in FJsonHubProtocol.

SerializeMessage()

virtual FString IHubProtocol::SerializeMessage ( const FHubMessage * ) const

pure virtual

Serializes a hub message to a string.

Parameters

Message

The message to serialize.

Returns

The serialized message.

Implemented in FJsonHubProtocol.

Version()

virtual int IHubProtocol::Version ( ) const

pure virtual

Gets the version of the protocol.

Returns

The version of the protocol.

Implemented in FJsonHubProtocol.

---

The documentation for this class was generated from the following files:

• IHubProtocol.h
• IHubProtocol.cpp