net.powermatcher.api

Interface Session

public interface Session

Session defines the interface for a link between an AgentEndpoint with a MatcherEndpoint in a Powermatcher cluster.

Method Summary

Methods

Modifier and Type	Method and Description
void	disconnect() Disconnect the AgentEndpoint from the MatcherEndpoint.
java.lang.String	getAgentId()
java.lang.String	getClusterId()
MarketBasis	getMarketBasis()
java.lang.String	getMatcherId()
java.lang.String	getSessionId()
void	setMarketBasis(MarketBasis marketBasis) Sets the MarketBasis for this session.
void	updateBid(BidUpdate newBid) Passes the Bid sent by the AgentEndpoint to the MatcherEndpoint of this session.
void	updatePrice(PriceUpdate priceUpdate) Passes the PriceUpdate sent by the MatcherEndpoint to the AgentEndpoint of this Session.

Method Detail

getAgentId

java.lang.String getAgentId()

Returns:

the agentId of the AgentEndpoint of this Session.

getMatcherId

java.lang.String getMatcherId()

Returns:

the agentId of the MatcherEndpoint of this Session.

getClusterId

java.lang.String getClusterId()

Returns:

the id of the cluster this Session is active in.

getSessionId

java.lang.String getSessionId()

Returns:

the id of this Session instance.

getMarketBasis

MarketBasis getMarketBasis()

Returns:

the MarketBasis used in this Session.

setMarketBasis

void setMarketBasis(MarketBasis marketBasis)

Sets the MarketBasis for this session. This should be set by the MatcherEndpoint when its MatcherEndpoint.connectToAgent(Session) method is called. This makes sure that the AgentEndpoint knows which MarketBasis is used for bidding.

Parameters:

marketBasis - the new marketBasis used in this Session.

updatePrice

void updatePrice(PriceUpdate priceUpdate)

Passes the PriceUpdate sent by the MatcherEndpoint to the AgentEndpoint of this Session. It calls AgentEndpoint.handlePriceUpdate(PriceUpdate).

Parameters:

priceUpdate - The PriceUpdate passed by the MatcherEndpoint of this Session.

updateBid

void updateBid(BidUpdate newBid)

Passes the Bid sent by the AgentEndpoint to the MatcherEndpoint of this session.

Parameters:

newBid - The Bid passed by the AgentEndpoint of this Session.

See Also:

MatcherEndpoint.handleBidUpdate(Session, BidUpdate)

disconnect

void disconnect()

Disconnect the AgentEndpoint from the MatcherEndpoint. This method should always call both the AgentEndpoint.matcherEndpointDisconnected(Session) and the MatcherEndpoint.agentEndpointDisconnected(Session) methods. This method can be called by any object, event the AgentEndpoint or MatcherEndpoint themselves.