[#BloombergLP-bslx-TestInStream_Proxy]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bslx.adoc[bslx]::TestInStream_Proxy
:relfileprefix: ../../
:mrdocs:

Proxy for a test stream used by the exception‐test macros.

== Synopsis

Declared in `<bslx_testinstream.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class BSLX_STREAM_TYPE>
class TestInStream_Proxy
    : public xref:BloombergLP/bslx/TestInStream_ProxyBase.adoc[TestInStream_ProxyBase]
----

== Description

This class provides a proxy to the test stream that is supplied to the `BSLX_TESTINSTREAM_EXCEPTION_TEST_BEGIN` macro. This proxy may be instantiated with `TestInStream`, or with a type that supports the same interface as `TestInStream`.

== Base Classes

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/bslx/TestInStream_ProxyBase.adoc[TestInStream_ProxyBase]`
| Common base class for `TestInStream_Proxy`.
|===

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslx/TestInStream_Proxy/2constructor.adoc[`TestInStream_Proxy`]         [.small]#[constructor]#
| Create a proxy for the specified `stream`.
| xref:BloombergLP/bslx/TestInStream_Proxy/2destructor.adoc[`~TestInStream_Proxy`] [.small]#[destructor]# [.small]#[virtual]#
| Destroy this object.
| xref:BloombergLP/bslx/TestInStream_Proxy/setInputLimit.adoc[`setInputLimit`]  [.small]#[virtual]#
| Set the input limit on the proxied stream to the specified `limit`.
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslx/TestInStream_getProxy.adoc[`TestInStream_getProxy`]
| Return, by value, a test stream proxy for the specified parameterized `stream`.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#