[#llvm-xray-CustomEventRecord]
= xref:llvm.adoc[llvm]::xref:llvm/xray.adoc[xray]::CustomEventRecord
:relfileprefix: ../../
:mrdocs:

Pre‐v5 metadata record for a user‐defined custom event.

== Synopsis

Declared in `<llvm/XRay/FDRRecords.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class CustomEventRecord
    : public xref:llvm/xray/MetadataRecord.adoc[MetadataRecord]
----

== Base Classes

[cols="1,4"]
|===
| Name| Description
| `xref:llvm/xray/MetadataRecord.adoc[MetadataRecord]`
| Base class for FDR metadata records that are not function enter/exit events.
|===

== Enums

[cols="1,4"]
|===
| Name| Description
| xref:llvm/xray/MetadataRecord/MetadataType-06.adoc[`MetadataType`] 
| Kind of metadata payload carried by a MetadataRecord subclass.
| xref:llvm/xray/Record/RecordKind.adoc[`RecordKind`] 
| Discriminator for concrete FDR record types in the class hierarchy.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:llvm/xray/CustomEventRecord/2constructor-03.adoc[`CustomEventRecord`]         [.small]#[constructor]#
| Constructors
| xref:llvm/xray/Record/operator_assign-0b.adoc[`operator=`] 
| Assignment operators
| xref:llvm/xray/CustomEventRecord/apply.adoc[`apply`]  [.small]#[virtual]#
| Apply visitor `V` to this custom‐event record.
| xref:llvm/xray/CustomEventRecord/cpu.adoc[`cpu`] 
| Return the CPU identifier where the event was recorded.
| xref:llvm/xray/CustomEventRecord/data.adoc[`data`] 
| Return the event payload data.
| xref:llvm/xray/Record/getRecordType.adoc[`getRecordType`] 
| Return the kind discriminator for this record.
| xref:llvm/xray/MetadataRecord/metadataType-0c.adoc[`metadataType`] 
| Return the metadata subtype for this record.
| xref:llvm/xray/CustomEventRecord/size.adoc[`size`] 
| Return the size of the event payload in bytes.
| xref:llvm/xray/CustomEventRecord/tsc.adoc[`tsc`] 
| Return the absolute timestamp counter value.
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:llvm/xray/CustomEventRecord/classof.adoc[`classof`] 
| Return true if `R` is a CustomEventRecord.
| xref:llvm/xray/Record/kindToString.adoc[`kindToString`] 
| Return a human‐readable name for record kind `K.`
|===


== Protected Static Data Members

[cols="1,4"]
|===
| Name| Description
| xref:llvm/xray/MetadataRecord/kMetadataBodySize.adoc[`kMetadataBodySize`] 
| Fixed size in bytes of a metadata record body after the type header.
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:llvm/xray/RecordInitializer.adoc[llvm::xray::RecordInitializer]`
| RecordVisitor that initializes FDR records by reading from a DataExtractor.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#