| Package | Description |
|---|---|
| io.pkts.packet.sip | |
| io.pkts.packet.sip.impl |
| Modifier and Type | Interface and Description |
|---|---|
static interface |
SipRequest.Builder |
static interface |
SipResponse.Builder |
| Modifier and Type | Method and Description |
|---|---|
SipMessage.Builder<? extends SipMessage> |
SipMessage.copy() |
SipMessage.Builder<T> |
SipMessage.Builder.onCommit(java.util.function.Consumer<SipMessage> f)
After the
SipMessage has been fully built and created the "end result"
will be conveyed to the registered function. |
SipMessage.Builder<T> |
SipMessage.Builder.onContactHeader(java.util.function.Consumer<AddressParametersHeader.Builder<ContactHeader>> f) |
SipMessage.Builder<T> |
SipMessage.Builder.onCSeqHeader(java.util.function.Consumer<CSeqHeader.Builder> f) |
SipMessage.Builder<T> |
SipMessage.Builder.onFromHeader(java.util.function.Consumer<AddressParametersHeader.Builder<FromHeader>> f) |
SipMessage.Builder<T> |
SipMessage.Builder.onHeader(java.util.function.Function<SipHeader,SipHeader> f)
Whenever a header is about to be pushed onto the new
SipMessage
you have a chance to change the value of that header. |
SipMessage.Builder<T> |
SipMessage.Builder.onMaxForwardsHeader(java.util.function.Consumer<MaxForwardsHeader.Builder> f) |
SipMessage.Builder<T> |
SipMessage.Builder.onRecordRouteHeader(java.util.function.Consumer<AddressParametersHeader.Builder<RecordRouteHeader>> f)
Called when a Record-Route header is processed (except for the top-most one,
then
onTopMostRecordRouteHeader(Consumer)
is called instead) |
SipMessage.Builder<T> |
SipMessage.Builder.onRequestURI(java.util.function.Function<SipURI,SipURI> f) |
SipMessage.Builder<T> |
SipMessage.Builder.onRouteHeader(java.util.function.Consumer<AddressParametersHeader.Builder<RouteHeader>> f)
Called when a Route header is processed (except for the top-most one,
then
onTopMostRouteHeader(Consumer)
is called instead) |
SipMessage.Builder<T> |
SipMessage.Builder.onToHeader(java.util.function.Consumer<AddressParametersHeader.Builder<ToHeader>> f) |
SipMessage.Builder<T> |
SipMessage.Builder.onTopMostRecordRouteHeader(java.util.function.Consumer<AddressParametersHeader.Builder<RecordRouteHeader>> f)
Called when the top-most Record Route header is processed.
|
SipMessage.Builder<T> |
SipMessage.Builder.onTopMostRouteHeader(java.util.function.Consumer<AddressParametersHeader.Builder<RouteHeader>> f)
Called when the top-most Route header is processed.
|
SipMessage.Builder<T> |
SipMessage.Builder.onTopMostViaHeader(java.util.function.Consumer<ViaHeader.Builder> f)
Called when the top-most Via header is processed.
|
SipMessage.Builder<T> |
SipMessage.Builder.onViaHeader(java.util.function.BiConsumer<Integer,ViaHeader.Builder> f)
Called when a Via header is processed and the first argument is the
index of the Via being processed.
|
default SipMessage.Builder<SipRequest> |
SipMessage.Builder.toSipRequestBuilder() |
default SipMessage.Builder<SipRequest> |
SipRequest.Builder.toSipRequestBuilder() |
default SipMessage.Builder<SipResponse> |
SipMessage.Builder.toSipResponseBuilder() |
default SipMessage.Builder<SipResponse> |
SipResponse.Builder.toSipResponseBuilder() |
SipMessage.Builder<T> |
SipMessage.Builder.withBody(Buffer body) |
SipMessage.Builder<T> |
SipMessage.Builder.withCallIdHeader(CallIdHeader callID) |
SipMessage.Builder<T> |
SipMessage.Builder.withContactHeader(ContactHeader contact) |
SipMessage.Builder<T> |
SipMessage.Builder.withCSeqHeader(CSeqHeader cseq) |
SipMessage.Builder<T> |
SipMessage.Builder.withFromHeader(FromHeader from)
Set the
FromHeader to be used by the new SipMessage. |
SipMessage.Builder<T> |
SipMessage.Builder.withFromHeader(String from) |
SipMessage.Builder<T> |
SipMessage.Builder.withHeader(SipHeader header)
Adds the header to the list of headers already specified within this builder.
|
SipMessage.Builder<T> |
SipMessage.Builder.withHeaders(List<SipHeader> headers) |
SipMessage.Builder<T> |
SipMessage.Builder.withMaxForwardsHeader(MaxForwardsHeader maxForwards) |
SipMessage.Builder<T> |
SipMessage.Builder.withNoDefaults()
By default, the following headers will automatically be generated if not
explicitly provided (note: there is a slight difference between request/response):
ToHeader - the request-uri will be used to construct the to-header
in the case of a request. |
SipMessage.Builder<T> |
SipMessage.Builder.withNoRoutes()
Sometimes you may want to just wipe out all the potential
RouteHeaders
that e.g. |
SipMessage.Builder<T> |
SipMessage.Builder.withPoppedRoute()
Pop the top-most route.
|
SipMessage.Builder<T> |
SipMessage.Builder.withPoppedVia()
Pop the top-most via.
|
SipMessage.Builder<T> |
SipMessage.Builder.withPushHeader(SipHeader header)
Push the header to be the first on the list of existing headers already
added to this builder.
|
SipMessage.Builder<T> |
SipMessage.Builder.withRecordRouteHeader(RecordRouteHeader recordRoute)
Set a Record Router header to be used on the message that is being built.
|
SipMessage.Builder<T> |
SipMessage.Builder.withRecordRouteHeaders(List<RecordRouteHeader> recordRoute) |
SipMessage.Builder<T> |
SipMessage.Builder.withRecordRouteHeaders(RecordRouteHeader... recordRoute)
Set a list of Record Route headers.
|
SipMessage.Builder<T> |
SipMessage.Builder.withRouteHeader(RouteHeader route)
Set a Router header to be used on the message that is being built.
|
SipMessage.Builder<T> |
SipMessage.Builder.withRouteHeaders(List<RouteHeader> routes) |
SipMessage.Builder<T> |
SipMessage.Builder.withRouteHeaders(RouteHeader... routes)
Set a list of Route headers.
|
SipMessage.Builder<T> |
SipMessage.Builder.withToHeader(String to) |
SipMessage.Builder<T> |
SipMessage.Builder.withToHeader(ToHeader to) |
SipMessage.Builder<T> |
SipMessage.Builder.withTopMostRecordRouteHeader(RecordRouteHeader recordRoute)
Push the given Record Route header to the top of the potential list of existing
Record Route headers.
|
SipMessage.Builder<T> |
SipMessage.Builder.withTopMostRouteHeader(RouteHeader route)
Push the given Route header to the top of the potential list of existing
Route headers.
|
SipMessage.Builder<T> |
SipMessage.Builder.withTopMostViaHeader()
Typically the
ViaHeader will have to be filled out by the stack at some
later point, which is when the message is about to be sent, so when you create
the message you don't have all the details just yet. |
SipMessage.Builder<T> |
SipMessage.Builder.withTopMostViaHeader(ViaHeader via)
Push the given Via header to the top of the potential list of existing
Via headers.
|
SipMessage.Builder<T> |
SipMessage.Builder.withViaHeader(ViaHeader via)
Add a Via header to be used on the message that is being built.
|
SipMessage.Builder<T> |
SipMessage.Builder.withViaHeaders(List<ViaHeader> vias)
Set a list of Via headers.
|
SipMessage.Builder<T> |
SipMessage.Builder.withViaHeaders(ViaHeader... vias)
Set a list of Via headers.
|
| Modifier and Type | Class and Description |
|---|---|
class |
SipMessageBuilder<T extends SipMessage> |
class |
SipRequestBuilder |
class |
SipResponseBuilder |
Copyright © 2016. All Rights Reserved.