net.powermatcher.api

Interface MatcherEndpoint

All Superinterfaces:

Agent

All Known Subinterfaces:

TransformingConcentrator

All Known Implementing Classes:

Auctioneer, BaseMatcherEndpoint, Concentrator, PeakShavingConcentrator

public interface MatcherEndpoint
extends Agent

MatcherEndpoint defines the interface for classes that can receive a Bid and send a PriceUpdate, containing a Price based on that Bid. A MatcherEndpoint can be linked with zero or more AgentEndpoint instances. These are linked by a Session.

Nested Class Summary

Nested classes/interfaces inherited from interface net.powermatcher.api.Agent

Agent.Status

Method Summary

Methods

Modifier and Type	Method and Description
void	agentEndpointDisconnected(Session session) Notifies the Agent that this MatcherEndpoint instance is disconnected from the AgentEndpoint.
void	connectToAgent(Session session) Connects this MatcherEndpoint instance to an AgentEndpoint.
void	handleBidUpdate(Session session, BidUpdate bidUpdate) Called by the AgentEndpoint via the Session to update the Bid used by this AgentEndpoint instance.

Methods inherited from interface net.powermatcher.api.Agent

getAgentId, getStatus, setContext

Method Detail

connectToAgent

void connectToAgent(Session session)

Connects this MatcherEndpoint instance to an AgentEndpoint.

Parameters:

session - the Session that will link this AgentEndpoint with a MatcherEndpoint.

Throws:

java.lang.IllegalArgumentException - when this matcher is not connected to the cluster

agentEndpointDisconnected

void agentEndpointDisconnected(Session session)

Notifies the Agent that this MatcherEndpoint instance is disconnected from the AgentEndpoint.

Parameters:

session - the Session that used to link this MatcherEndpoint with an AgentEndpoint.

handleBidUpdate

void handleBidUpdate(Session session,
                   BidUpdate bidUpdate)

Called by the AgentEndpoint via the Session to update the Bid used by this AgentEndpoint instance.

Parameters:

session - The session linking this MatcherEndpoint with a specific AgentEndpoint instance.

bidUpdate - The new BidUpdate.