com.hp.sdn.trace

Interface TraceService

public interface TraceService

API to access controller TX/RX tracing functionality.

Author:

Simon Hunt, Thomas Vachuska, Jesse Hummer, Shaila Shree, Frank Wood, Scott Simes

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the entire store trace.
String	exportTrace() Initiates the export of the trace data to a CSV file, and returns a ticket to be used to request the file from the server.
File	fetchExportedCsv(String ticket) Fetches the exported CSV file for the given claim ticket.
long	getBookmark() Returns the current bookmark value.
MessageEventWrapper	getEvent(long bookmark) Returns the message event associated with the given bookmark ID, or null if no such event is stored.
Trace	getTrace(long bookmark) Returns the trace descriptor with message events recorded since the specified bookmark.
String	getTraceAsCsv() Returns the trace data as a CSV string.
Trace	getTraceOrWait(long bookmark, long maxWaitMillis) Returns the trace descriptor with the message events recorded since the specified bookmark.
boolean	recording() Returns the current recording status of the OpenFlow controller.
boolean	start() Starts trace recording for the default time period.
boolean	start(int seconds) Starts recording for the specified number of seconds.
void	stop() Stops recording immediately.

Method Detail

recording

boolean recording()

Returns the current recording status of the OpenFlow controller.

Returns:

true if recording is active, false otherwise

getBookmark

long getBookmark()

Returns the current bookmark value.

Returns:

the earliest bookmark value

start

boolean start()

Starts trace recording for the default time period.

Returns:

true if recording is successfully started, false otherwise

start

boolean start(int seconds)

Starts recording for the specified number of seconds. Number of seconds will be limited to a pre-configured maximum.

Parameters:

seconds - duration of recording in seconds

Returns:

true if recording is successfully started, false otherwise

stop

void stop()

Stops recording immediately.

clear

void clear()

Clears the entire store trace. If recording, there will be no effect on current recording state.

getTrace

Trace getTrace(long bookmark)

Returns the trace descriptor with message events recorded since the specified bookmark. If there are no message events since the specified bookmark, the trace message event list will be empty.

Parameters:

bookmark - identification bookmark

Returns:

trace since the specified bookmark

getTraceOrWait

Trace getTraceOrWait(long bookmark,
                     long maxWaitMillis)

Returns the trace descriptor with the message events recorded since the specified bookmark. If there are no messages events since the specified bookmark, the thread will block until either a new message event occurs or the specified maximum wait time.

Parameters:

bookmark - identification bookmark

maxWaitMillis - the maximum time in milliseconds to wait for the arrival of a new message event

Returns:

trace since the specified bookmark

getEvent

MessageEventWrapper getEvent(long bookmark)

Returns the message event associated with the given bookmark ID, or null if no such event is stored.

Parameters:

bookmark - identification bookmark

Returns:

the associated message event

getTraceAsCsv

String getTraceAsCsv()

Returns the trace data as a CSV string.

Returns:

the trace as CSV

exportTrace

String exportTrace()
            throws IOException

Initiates the export of the trace data to a CSV file, and returns a ticket to be used to request the file from the server.

Returns:

the claim ticket

Throws:

IOException - if staging area for CSV file cannot be created

fetchExportedCsv

File fetchExportedCsv(String ticket)

Fetches the exported CSV file for the given claim ticket. An exception is thrown if the csv file associated with the ticket cannot be found.

Parameters:

ticket - the ticket issued when the request was made

Returns:

the exported CSV file

Throws:

IllegalArgumentException - if ticket is invalid