define a public api for the processor