wangle::Pipeline< R, W > Class Template Reference

#include <Pipeline.h>

Inheritance diagram for wangle::Pipeline< R, W >:

Public Types
using	Ptr = std::shared_ptr< Pipeline >

Public Member Functions
	~Pipeline () override
template<class T = R>
std::enable_if<!std::is_same< T, folly::Unit >::value >::type	read (R msg)
template<class T = R>
std::enable_if<!std::is_same< T, folly::Unit >::value >::type	readEOF ()
template<class T = R>
std::enable_if<!std::is_same< T, folly::Unit >::value >::type	readException (folly::exception_wrapper e)
template<class T = R>
std::enable_if<!std::is_same< T, folly::Unit >::value >::type	transportActive ()
template<class T = R>
std::enable_if<!std::is_same< T, folly::Unit >::value >::type	transportInactive ()
template<class T = W>
std::enable_if<!std::is_same< T, folly::Unit >::value, folly::Future< folly::Unit > >::type	write (W msg)
template<class T = W>
std::enable_if<!std::is_same< T, folly::Unit >::value, folly::Future< folly::Unit > >::type	writeException (folly::exception_wrapper e)
template<class T = W>
std::enable_if<!std::is_same< T, folly::Unit >::value, folly::Future< folly::Unit > >::type	close ()
void	finalize () override
Public Member Functions inherited from wangle::PipelineBase
virtual	~PipelineBase ()=default
void	setPipelineManager (PipelineManager *manager)
PipelineManager *	getPipelineManager ()
void	deletePipeline ()
void	setTransport (std::shared_ptr< folly::AsyncTransport > transport)
std::shared_ptr< folly::AsyncTransport >	getTransport ()
void	setWriteFlags (folly::WriteFlags flags)
folly::WriteFlags	getWriteFlags ()
void	setReadBufferSettings (uint64_t minAvailable, uint64_t allocationSize)
std::pair< uint64_t, uint64_t >	getReadBufferSettings ()
void	setTransportInfo (std::shared_ptr< TransportInfo > tInfo)
std::shared_ptr< TransportInfo >	getTransportInfo ()
template<class H >
PipelineBase &	addBack (std::shared_ptr< H > handler)
template<class H >
PipelineBase &	addBack (H &&handler)
template<class H >
PipelineBase &	addBack (H *handler)
template<class H >
PipelineBase &	addFront (std::shared_ptr< H > handler)
template<class H >
PipelineBase &	addFront (H &&handler)
template<class H >
PipelineBase &	addFront (H *handler)
template<class H >
PipelineBase &	remove (H *handler)
template<class H >
PipelineBase &	remove ()
PipelineBase &	removeFront ()
PipelineBase &	removeBack ()
template<class H >
H *	getHandler (int i)
template<class H >
H *	getHandler ()
template<class H >
ContextType< H >::type *	getContext (int i)
template<class H >
ContextType< H >::type *	getContext ()
template<class H >
bool	setOwner (H *handler)
size_t	numHandlers () const

Static Public Member Functions
static Ptr	create ()

Protected Member Functions
	Pipeline ()
	Pipeline (bool isStatic)
Protected Member Functions inherited from wangle::PipelineBase
template<class Context >
void	addContextFront (Context *ctx)
void	detachHandlers ()

Private Attributes
bool	isStatic_ {false}
InboundLink< R > *	front_ {nullptr}
OutboundLink< W > *	back_ {nullptr}

Additional Inherited Members
Protected Attributes inherited from wangle::PipelineBase
std::vector< std::shared_ptr< PipelineContext > >	ctxs_
std::vector< PipelineContext * >	inCtxs_
std::vector< PipelineContext * >	outCtxs_

Detailed Description

template<class R, class W = folly::Unit>
class wangle::Pipeline< R, W >

Definition at line 170 of file Pipeline.h.

Member Typedef Documentation

template<class R, class W = folly::Unit>

using wangle::Pipeline< R, W >::Ptr = std::shared_ptr<Pipeline>

Definition at line 172 of file Pipeline.h.

Constructor & Destructor Documentation

template<class R , class W >

wangle::Pipeline< R, W >::~Pipeline ( )

override

Definition at line 32 of file Pipeline-inl.h.

References wangle::PipelineBase::detachHandlers(), and wangle::Pipeline< R, W >::isStatic_.

                          {
  if (!isStatic_) {
    detachHandlers();
  }
}

template<class R , class W >

wangle::Pipeline< R, W >::Pipeline ( )

protected

Definition at line 24 of file Pipeline-inl.h.

: isStatic_(false) {}

template<class R , class W >

wangle::Pipeline< R, W >::Pipeline ( bool  isStatic )

explicitprotected

Definition at line 27 of file Pipeline-inl.h.

References wangle::Pipeline< R, W >::isStatic_.

                                      : isStatic_(isStatic) {
  CHECK(isStatic_);
}

Member Function Documentation

template<class R , class W >

template<class T >

std::enable_if<!std::is_same< T, folly::Unit >::value, folly::Future< folly::Unit > >::type wangle::Pipeline< R, W >::close

(

)

Definition at line 258 of file Pipeline-inl.h.

References wangle::Pipeline< R, W >::back_, and wangle::OutboundLink< Out >::close().

Referenced by AcceptRoutingHandlerTest::clientConnectAndCleanClose().

                      {
  if (!back_) {
    throw std::invalid_argument("close(): no outbound handler in Pipeline");
  }
  return back_->close();
}

template<class R, class W = folly::Unit>

static Ptr wangle::Pipeline< R, W >::create ( )

inlinestatic

Definition at line 174 of file Pipeline.h.

Referenced by TestClientPipelineFactory::newPipeline(), RpcPipelineFactory::newPipeline(), EchoPipelineFactory::newPipeline(), TelnetPipelineFactory::newPipeline(), TestPipelineFactory::newPipeline(), wangle::ServerPipelineFactory< Req, Resp >::newPipeline(), CustomPipelineFactory::newPipeline(), wangle::ClientPipelineFactory< Req, Resp >::newPipeline(), FileServerPipelineFactory::newPipeline(), wangle::ObservingPipelineFactory< std::string, std::string >::newPipeline(), wangle::AcceptRoutingPipelineFactory< Pipeline, R >::newPipeline(), wangle::MockDownstreamPipelineFactory::newPipeline(), wangle::MockBroadcastPipelineFactory::newPipeline(), wangle::MockObservingPipelineFactory::newPipeline(), SimpleObservingPipelineFactory::newPipeline(), TestHandlerPipelineFactory< HandlerPipeline >::newPipeline(), wangle::DefaultAcceptPipelineFactory::newPipeline(), wangle::AcceptRoutingHandler< DefaultPipeline, char >::newRoutingPipeline(), ObservingHandlerTest::SetUp(), and BroadcastHandlerTest::SetUp().

                      {
    return std::shared_ptr<Pipeline>(new Pipeline());
  }

template<class R , class W >

void wangle::Pipeline< R, W >::finalize ( )

overridevirtual

Implements wangle::PipelineBase.

Definition at line 267 of file Pipeline-inl.h.

References wangle::Pipeline< R, W >::back_, wangle::PipelineBase::ctxs_, wangle::Pipeline< R, W >::front_, i, wangle::PipelineBase::inCtxs_, and wangle::PipelineBase::outCtxs_.

Referenced by wangle::StaticPipeline< R, W >::initialize(), and wangle::ClientDispatcherBase< wangle::Pipeline, folly::Req, Resp >::setPipeline().

                              {
  front_ = nullptr;
  if (!inCtxs_.empty()) {
    front_ = dynamic_cast<InboundLink<R>*>(inCtxs_.front());
    for (size_t i = 0; i < inCtxs_.size() - 1; i++) {
      inCtxs_[i]->setNextIn(inCtxs_[i+1]);
    }
    inCtxs_.back()->setNextIn(nullptr);
  }

  back_ = nullptr;
  if (!outCtxs_.empty()) {
    back_ = dynamic_cast<OutboundLink<W>*>(outCtxs_.back());
    for (size_t i = outCtxs_.size() - 1; i > 0; i--) {
      outCtxs_[i]->setNextOut(outCtxs_[i-1]);
    }
    outCtxs_.front()->setNextOut(nullptr);
  }

  if (!front_) {
    detail::logWarningIfNotUnit<R>(
        "No inbound handler in Pipeline, inbound operations will throw "
        "std::invalid_argument");
  }
  if (!back_) {
    detail::logWarningIfNotUnit<W>(
        "No outbound handler in Pipeline, outbound operations will throw "
        "std::invalid_argument");
  }

  for (auto it = ctxs_.rbegin(); it != ctxs_.rend(); it++) {
    (*it)->attachPipeline();
  }
}

template<class R, class W >

template<class T >

std::enable_if<!std::is_same< T, folly::Unit >::value >::type wangle::Pipeline< R, W >::read

(

R

msg

)

Definition at line 185 of file Pipeline-inl.h.

References wangle::Pipeline< R, W >::front_, wangle::InboundLink< In >::read(), type, and value.

                          {
  if (!front_) {
    throw std::invalid_argument("read(): no inbound handler in Pipeline");
  }
  front_->read(std::forward<R>(msg));
}

template<class R , class W >

template<class T >

std::enable_if<!std::is_same< T, folly::Unit >::value >::type wangle::Pipeline< R, W >::readEOF

(

)

Definition at line 195 of file Pipeline-inl.h.

References wangle::Pipeline< R, W >::front_, wangle::InboundLink< In >::readEOF(), type, and value.

Referenced by TEST_F().

                        {
  if (!front_) {
    throw std::invalid_argument("readEOF(): no inbound handler in Pipeline");
  }
  front_->readEOF();
}

template<class R , class W >

template<class T >

std::enable_if<!std::is_same< T, folly::Unit >::value >::type wangle::Pipeline< R, W >::readException

(

folly::exception_wrapper

e

)

Definition at line 223 of file Pipeline-inl.h.

References wangle::Pipeline< R, W >::front_, folly::gen::move, wangle::InboundLink< In >::readException(), type, and value.

Referenced by TEST_F().

                                                      {
  if (!front_) {
    throw std::invalid_argument(
        "readException(): no inbound handler in Pipeline");
  }
  front_->readException(std::move(e));
}

template<class R , class W >

template<class T >

std::enable_if<!std::is_same< T, folly::Unit >::value >::type wangle::Pipeline< R, W >::transportActive

(

)

Definition at line 205 of file Pipeline-inl.h.

References wangle::Pipeline< R, W >::front_, wangle::InboundLink< In >::transportActive(), type, and value.

Referenced by wangle::ClientBootstrap< Pipeline >::ConnectCallback::connectSuccess(), and ProxyFrontendHandler::transportActive().

                                {
  if (front_) {
    front_->transportActive();
  }
}

template<class R , class W >

template<class T >

std::enable_if<!std::is_same< T, folly::Unit >::value >::type wangle::Pipeline< R, W >::transportInactive

(

)

Definition at line 214 of file Pipeline-inl.h.

References wangle::Pipeline< R, W >::front_, wangle::InboundLink< In >::transportInactive(), type, and value.

Referenced by ProxyFrontendHandler::transportActive().

                                  {
  if (front_) {
    front_->transportInactive();
  }
}

template<class R , class W>

template<class T >

std::enable_if<!std::is_same< T, folly::Unit >::value, folly::Future< folly::Unit > >::type wangle::Pipeline< R, W >::write

(

W

msg

)

Definition at line 235 of file Pipeline-inl.h.

References wangle::Pipeline< R, W >::back_, type, value, and wangle::OutboundLink< Out >::write().

Referenced by AcceptRoutingHandlerTest::clientConnectAndWrite(), wangle::SerialClientDispatcher< wangle::Pipeline, folly::Req, Resp >::operator()(), and wangle::PipelinedClientDispatcher< Pipeline, Req, Resp >::operator()().

                           {
  if (!back_) {
    throw std::invalid_argument("write(): no outbound handler in Pipeline");
  }
  return back_->write(std::forward<W>(msg));
}

template<class R , class W >

template<class T >

std::enable_if<!std::is_same< T, folly::Unit >::value, folly::Future< folly::Unit > >::type wangle::Pipeline< R, W >::writeException

(

folly::exception_wrapper

e

)

Definition at line 246 of file Pipeline-inl.h.

References wangle::Pipeline< R, W >::back_, folly::gen::move, type, value, and wangle::OutboundLink< Out >::writeException().

Referenced by AcceptRoutingHandlerTest::sendClientException(), and TEST_F().

                                                         {
  if (!back_) {
    throw std::invalid_argument(
      "writeException(): no outbound handler in Pipeline");
  }
  return back_->writeException(std::move(e));
}

Member Data Documentation

template<class R, class W = folly::Unit>

OutboundLink<W>* wangle::Pipeline< R, W >::back_ {nullptr}

private

Definition at line 225 of file Pipeline.h.

Referenced by wangle::Pipeline< R, W >::close(), wangle::Pipeline< R, W >::finalize(), wangle::Pipeline< R, W >::write(), and wangle::Pipeline< R, W >::writeException().

template<class R, class W = folly::Unit>

InboundLink<R>* wangle::Pipeline< R, W >::front_ {nullptr}

private

Definition at line 224 of file Pipeline.h.

Referenced by wangle::Pipeline< R, W >::finalize(), wangle::Pipeline< R, W >::read(), wangle::Pipeline< R, W >::readEOF(), wangle::Pipeline< R, W >::readException(), wangle::Pipeline< R, W >::transportActive(), and wangle::Pipeline< R, W >::transportInactive().

template<class R, class W = folly::Unit>

bool wangle::Pipeline< R, W >::isStatic_ {false}

private

Definition at line 222 of file Pipeline.h.

Referenced by wangle::Pipeline< R, W >::Pipeline(), and wangle::Pipeline< R, W >::~Pipeline().

---

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

• proxygen/wangle/wangle/channel/Pipeline.h
• proxygen/wangle/wangle/channel/Pipeline-inl.h