Struct cfx_rpc_builder::RpcServerConfig
source · pub struct RpcServerConfig { /* private fields */ }
Expand description
A builder type for configuring and launching the servers that will handle RPC requests.
Supported server transports are:
- http
- ws
Http and WS share the same settings: ServerBuilder
.
Once the [RpcModule
] is built via RpcModuleBuilder
the servers can be
started, See also ServerBuilder::build
and
Server::start
.
Implementations§
source§impl RpcServerConfig
impl RpcServerConfig
sourcepub fn http(config: ServerBuilder<Identity, Identity>) -> Self
pub fn http(config: ServerBuilder<Identity, Identity>) -> Self
Creates a new config with only http set
sourcepub fn ws(config: ServerBuilder<Identity, Identity>) -> Self
pub fn ws(config: ServerBuilder<Identity, Identity>) -> Self
Creates a new config with only ws set
sourcepub fn with_http(self, config: ServerBuilder<Identity, Identity>) -> Self
pub fn with_http(self, config: ServerBuilder<Identity, Identity>) -> Self
Configures the http server
Note: this always configures an EthSubscriptionIdProvider
[IdProvider
] for convenience. To set a custom [IdProvider
],
please use Self::with_id_provider
.
sourcepub fn with_ws(self, config: ServerBuilder<Identity, Identity>) -> Self
pub fn with_ws(self, config: ServerBuilder<Identity, Identity>) -> Self
Configures the ws server
Note: this always configures an EthSubscriptionIdProvider
[IdProvider
] for convenience. To set a custom [IdProvider
],
please use Self::with_id_provider
.
source§impl RpcServerConfig
impl RpcServerConfig
sourcepub fn with_cors(self, cors_domain: Option<String>) -> Self
pub fn with_cors(self, cors_domain: Option<String>) -> Self
Configure rpc middleware Configure the cors domains for http and ws
sourcepub fn with_ws_cors(self, cors_domain: Option<String>) -> Self
pub fn with_ws_cors(self, cors_domain: Option<String>) -> Self
Configure the cors domains for WS
sourcepub fn with_http_cors(self, cors_domain: Option<String>) -> Self
pub fn with_http_cors(self, cors_domain: Option<String>) -> Self
Configure the cors domains for HTTP
sourcepub const fn with_http_address(self, addr: SocketAddr) -> Self
pub const fn with_http_address(self, addr: SocketAddr) -> Self
Configures the SocketAddr
of the http server
Default is Ipv4Addr::LOCALHOST
and
sourcepub const fn with_ws_address(self, addr: SocketAddr) -> Self
pub const fn with_ws_address(self, addr: SocketAddr) -> Self
Configures the SocketAddr
of the ws server
Default is Ipv4Addr::LOCALHOST
and
sourcepub fn with_id_provider<I>(self, id_provider: I) -> Selfwhere
I: IdProvider + Clone + 'static,
pub fn with_id_provider<I>(self, id_provider: I) -> Selfwhere
I: IdProvider + Clone + 'static,
Sets a custom [IdProvider
] for all configured transports.
By default all transports use EthSubscriptionIdProvider
sourcepub const fn has_server(&self) -> bool
pub const fn has_server(&self) -> bool
Returns true if any server is configured.
If no server is configured, no server will be launched on
RpcServerConfig::start
.
sourcepub const fn http_address(&self) -> Option<SocketAddr>
pub const fn http_address(&self) -> Option<SocketAddr>
Returns the SocketAddr
of the http server
sourcepub const fn ws_address(&self) -> Option<SocketAddr>
pub const fn ws_address(&self) -> Option<SocketAddr>
Returns the SocketAddr
of the ws server
pub async fn start( self, modules: &TransportRpcModules, throttling_conf_file: Option<String>, enable_metrics: bool ) -> Result<RpcServerHandle, RpcError>
Trait Implementations§
source§impl Debug for RpcServerConfig
impl Debug for RpcServerConfig
Auto Trait Implementations§
impl !RefUnwindSafe for RpcServerConfig
impl Send for RpcServerConfig
impl Sync for RpcServerConfig
impl Unpin for RpcServerConfig
impl !UnwindSafe for RpcServerConfig
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Conv for T
impl<T> Conv for T
source§impl<T> ElementSatisfy<ElementNoConstrain> for T
impl<T> ElementSatisfy<ElementNoConstrain> for T
fn to_constrain_object(&self) -> &ElementNoConstrain
fn to_constrain_object_mut(&mut self) -> &mut ElementNoConstrain
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.