Struct Upstream

pub struct Upstream {
    pub name: String,
    pub key: String,
    /* private fields */
}

Represents a group of backend servers and their configuration for load balancing and connection management

Fields

name: String

Unique identifier for this upstream group

key: String

Hash key used to detect configuration changes

Implementations

impl Upstream

pub fn new( name: &str, conf: &UpstreamConf, sender: Option<Arc<NotificationSender>>, ) -> Result<Self, Error>

Creates a new Upstream instance from the provided configuration

Arguments

• name - Name identifier for the upstream service
• conf - Configuration parameters for the upstream service

Returns

• Result<Self> - New Upstream instance or error if creation fails

pub fn new_http_peer( &self, session: &Session, client_ip: &Option<String>, ) -> Option<HttpPeer>

Creates and configures a new HTTP peer for handling requests

Arguments

• session - Current HTTP session containing request details
• ctx - Request context state

Returns

• Option<HttpPeer> - Configured HTTP peer if a healthy backend is available, None otherwise

This method:

1. Selects an appropriate backend using the configured load balancing strategy
2. Increments the processing counter
3. Creates and configures an HttpPeer with the connection settings

pub fn connected(&self) -> Option<i32>

Returns the current number of active connections to this upstream

Returns

• Option<i32> - Number of active connections if tracking is enabled, None otherwise

pub fn as_round_robin(&self) -> Option<Arc<LoadBalancer<RoundRobin>>>

Returns the round-robin load balancer if configured

Returns

• Option<Arc<LoadBalancer<RoundRobin>>> - Round-robin load balancer if used, None otherwise

pub fn as_consistent(&self) -> Option<Arc<LoadBalancer<Consistent>>>

Returns the consistent hash load balancer if configured

Returns

• Option<Arc<LoadBalancer<Consistent>>> - Consistent hash load balancer if used, None otherwise

pub fn completed(&self) -> i32

Decrements and returns the number of requests being processed

Returns

• i32 - Previous count of requests being processed

Trait Implementations

impl Debug for Upstream

fn fmt(&self, __derive_more_f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.