com.github.kayak.core

Class Bus

java.lang.Object

com.github.kayak.core.Bus

All Implemented Interfaces:

SubscriptionChangeListener, java.util.EventListener

public class Bus
extends java.lang.Object
implements SubscriptionChangeListener

A Bus is the virtual representation of a CAN bus. It connects different FrameSources and FrameReceivers for message transport. It also sets the time stamp of each frame to synchronize the message flow.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.regex.Pattern	BUS_NAME_PATTERN

Constructor Summary

Constructors

Constructor and Description
Bus()

Method Summary

Modifier and Type	Method and Description
void	addBusChangeListener(BusChangeListener listener) A BusChangeListener may use this method if he wants to be notified about changes to the bus like added connections etc.
void	addEventFrameListener(EventFrameListener listener)
void	addSendJob(int id, boolean extended, byte[] data, long usec)
void	addSubscription(Subscription s)
void	destroy() Shall be called if the bus is removed.
void	disableStatistics()
void	disconnect() If the Bus was connected terminate all connections.
void	enableStatistics(int interval)
java.lang.String	getAlias() Returns the human readable name of the bus.
BusURL	getConnection()
BusDescription	getDescription()
java.lang.String	getName() Returns the name of the bus.
TimeSource	getTimeSource()
void	registerStatisticsReceiver(StatisticsListener receiver)
void	removeBusChangeListener(BusChangeListener listener)
void	removeEventFrameListener(EventFrameListener listener)
void	removeSendJob(int id, boolean extended)
void	removeStatisticsReceiver(StatisticsListener receiver)
void	sendEventFrame(EventFrame f)
void	sendFrame(Frame frame) Send a frame on the bus.
void	setAlias(java.lang.String alias)
void	setConnection(BusURL url) Connect the Bus to a given BusURL.
void	setDescription(BusDescription desc)
void	setName(java.lang.String name)
void	setTimeSource(TimeSource timeSource) Set the TimeSource that will be used to coordinate the message flow on the bus (play, pause, timestamps...)
void	subscribed(int id, boolean extended, Subscription s)
void	subscriptionAllChanged(boolean all, Subscription s)
void	subscriptionTerminated(Subscription s)
java.lang.String	toString()
void	unsubscribed(int id, boolean extended, Subscription s)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

BUS_NAME_PATTERN

public static final java.util.regex.Pattern BUS_NAME_PATTERN

Constructor Detail

Bus

public Bus()

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getConnection

public BusURL getConnection()

getName

public java.lang.String getName()

Returns the name of the bus. This name is used internally and has to match a specific pattern. A human readable name can be set with 'alias

setName

public void setName(java.lang.String name)

getAlias

public java.lang.String getAlias()

Returns the human readable name of the bus.

setAlias

public void setAlias(java.lang.String alias)

registerStatisticsReceiver

public void registerStatisticsReceiver(StatisticsListener receiver)

removeStatisticsReceiver

public void removeStatisticsReceiver(StatisticsListener receiver)

enableStatistics

public void enableStatistics(int interval)

disableStatistics

public void disableStatistics()

destroy

public void destroy()

Shall be called if the bus is removed. This will inform all components using the bus that it will not be present any more. Also all connections are terminated.

getTimeSource

public TimeSource getTimeSource()

setTimeSource

public void setTimeSource(TimeSource timeSource)

Set the TimeSource that will be used to coordinate the message flow on the bus (play, pause, timestamps...)

addSubscription

public void addSubscription(Subscription s)

Specified by:

addSubscription in interface SubscriptionChangeListener

subscribed

public void subscribed(int id,
                       boolean extended,
                       Subscription s)

Specified by:

subscribed in interface SubscriptionChangeListener

unsubscribed

public void unsubscribed(int id,
                         boolean extended,
                         Subscription s)

Specified by:

unsubscribed in interface SubscriptionChangeListener

subscriptionAllChanged

public void subscriptionAllChanged(boolean all,
                                   Subscription s)

Specified by:

subscriptionAllChanged in interface SubscriptionChangeListener

subscriptionTerminated

public void subscriptionTerminated(Subscription s)

Specified by:

subscriptionTerminated in interface SubscriptionChangeListener

addBusChangeListener

public void addBusChangeListener(BusChangeListener listener)

A BusChangeListener may use this method if he wants to be notified about changes to the bus like added connections etc.

removeBusChangeListener

public void removeBusChangeListener(BusChangeListener listener)

setConnection

public void setConnection(BusURL url)

Connect the Bus to a given BusURL. Internally a RAW- and a BCM connection will be opened. If the Bus was already connected it is disconnected first.

disconnect

public void disconnect()

If the Bus was connected terminate all connections.

sendFrame

public void sendFrame(Frame frame)

Send a frame on the bus. All FrameReceivers will also receive this frame.

addSendJob

public void addSendJob(int id,
                       boolean extended,
                       byte[] data,
                       long usec)

removeSendJob

public void removeSendJob(int id,
                          boolean extended)

addEventFrameListener

public void addEventFrameListener(EventFrameListener listener)

removeEventFrameListener

public void removeEventFrameListener(EventFrameListener listener)

sendEventFrame

public void sendEventFrame(EventFrame f)

setDescription

public void setDescription(BusDescription desc)

getDescription

public BusDescription getDescription()