PeanutButter.TestUtils.AspNetCore.Builders.WebSocketBuilder Class Reference

Builds a fake web socket. More...

Inheritance diagram for PeanutButter.TestUtils.AspNetCore.Builders.WebSocketBuilder:

Public Member Functions
override WebSocketBuilder	Randomize ()
	Does nothing - only here so that GetRandom works.
WebSocketBuilder	WithReceiveHandler (Func< ArraySegment< byte >, CancellationToken, Task< WebSocketReceiveResult > > handler)
	Sets the receive handler for the fake socket.
WebSocketBuilder	WithSendHandler (Func< ArraySegment< byte >, WebSocketMessageType, bool, CancellationToken, Task > handler)
	Sets the send handler for the fake socket.
WebSocketBuilder	WithSubProtocol (string subProtocol)
	Sets the sub-protocol for the fake socket.
Public Member Functions inherited from PeanutButter.TestUtils.AspNetCore.Builders.RandomizableBuilder< TBuilder, TSubject >
TBuilder	Randomize ()
	Derivatives must implement this so that BuildRandom can work.
Public Member Functions inherited from PeanutButter.TestUtils.AspNetCore.Builders.Builder< TBuilder, TSubject >
TBuilder	With (Action< TSubject > action)
	Adds a mutator for the artifact.
virtual TSubject	Build ()
	Builds the subject artifact.
	Mutator (Action< T > action, string identifier)

Protected Member Functions
override WebSocket	ConstructEntity ()
	Constructs the fake web socket.
Protected Member Functions inherited from PeanutButter.TestUtils.AspNetCore.Builders.Builder< TBuilder, TSubject >
TBuilder	With (Action< TSubject > action, string identifier)
	Adds an identified mutator for the artifact - if a mutator with the same identity already exists, it will be removed.
TBuilder	With< TCast > (Action< TCast > action)
	Adds a mutator for the artifact, cast to TCast.
TBuilder	With< TCast > (Action< TCast > action, string identifier)
	Adds an identified mutator for the artifact, cast to TCast.
TBuilder	WithRandomTimes (Action< TSubject > action)
	Applies the given mutator a random (1-4) number of times.
TBuilder	WithRandomTimes< TCast > (Action< TCast > action)
	Applies the given mutator on a cast item a random (1-4) number of times.
TBuilder	WithPreCursor (Action toRun)
	Run a precursor before your entity is constructed - use when your entity requires constructor parameters you'd like to make user-tweakable via builder methods.
TBuilder	WithPostBuild (Action< TSubject > action)
	Add post-build actions.

Additional Inherited Members
Static Public Member Functions inherited from PeanutButter.TestUtils.AspNetCore.Builders.RandomizableBuilder< TBuilder, TSubject >
static TSubject	BuildRandom ()
	Builds a random variant output artifact.
Static Public Member Functions inherited from PeanutButter.TestUtils.AspNetCore.Builders.Builder< TBuilder, TSubject >
static TBuilder	Create ()
	Returns a new instance of the builder.
static TSubject	BuildDefault ()
	Builds the default output artifact.
Static Protected Member Functions inherited from PeanutButter.TestUtils.AspNetCore.Builders.Builder< TBuilder, TSubject >
static void	WarnIf (bool condition, string message)
	Print a traced warning if the condition is found to be false.
static void	ErrorIf (bool condition, string message)
	Print a traced warning if the condition is found to be false.
Protected Attributes inherited from PeanutButter.TestUtils.AspNetCore.Builders.Builder< TBuilder, TSubject >
TSubject	CurrentEntity
	During build, CurrentEntity will be set to the currently-building entity. You may implement actualizer(s) in your derivative to pull this value in lazily to consumers.
Properties inherited from PeanutButter.TestUtils.AspNetCore.Builders.Builder< TBuilder, TSubject >
Action< T >	Action [get]
string	Identifier [get]

Detailed Description

Builds a fake web socket.

Member Function Documentation

ConstructEntity()

override WebSocket PeanutButter.TestUtils.AspNetCore.Builders.WebSocketBuilder.ConstructEntity ( )

protectedvirtual

Constructs the fake web socket.

Returns

Reimplemented from PeanutButter.TestUtils.AspNetCore.Builders.Builder< TBuilder, TSubject >.

Randomize()

override WebSocketBuilder PeanutButter.TestUtils.AspNetCore.Builders.WebSocketBuilder.Randomize

(

)

Does nothing - only here so that GetRandom works.

Returns

WithReceiveHandler()

WebSocketBuilder PeanutButter.TestUtils.AspNetCore.Builders.WebSocketBuilder.WithReceiveHandler

(

Func< ArraySegment< byte >, CancellationToken, Task< WebSocketReceiveResult > >

handler

)

Sets the receive handler for the fake socket.

Parameters

handler

Returns

WithSendHandler()

WebSocketBuilder PeanutButter.TestUtils.AspNetCore.Builders.WebSocketBuilder.WithSendHandler

(

Func< ArraySegment< byte >, WebSocketMessageType, bool, CancellationToken, Task >

handler

)

Sets the send handler for the fake socket.

Parameters

handler

Returns

WithSubProtocol()

WebSocketBuilder PeanutButter.TestUtils.AspNetCore.Builders.WebSocketBuilder.WithSubProtocol

(

string

subProtocol

)

Sets the sub-protocol for the fake socket.

Parameters

subProtocol

Returns

---

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

• source/TestUtils/PeanutButter.TestUtils.AspNetCore/Builders/WebSocketBuilder.cs